|
| 1 | +# ecoAPM Contribution Guidelines |
| 2 | + |
| 3 | +First of all, thank you for your interest in contributing! |
| 4 | + |
| 5 | +This document represents a general set of guidelines to help make the process of community contributions as smooth as possible for all parties involved. |
| 6 | + |
| 7 | +#### Please read the [Code of Conduct](CODE_OF_CONDUCT.md) prior to participating |
| 8 | + - This is the standard "Contributor Covenant" used throughout all ecoAPM codebases, and widely across the OSS landscape |
| 9 | + - Building a strong, professional, caring, and empathetic community is paramount in our goal as an OSS company |
| 10 | + |
| 11 | +#### Discussions about changes should happen in an issue before creating a pull request |
| 12 | + - While a change may make sense for a specific use case, it may not match the larger goals of the project as initially formulated by the original contributor |
| 13 | + - Prior discussion can help give direction to how a feature or bug fix could best be implemented to meet everyone's needs |
| 14 | + |
| 15 | +#### Follow the standard issue template formats for reporting bugs and requesting new features |
| 16 | + - These make reading, understanding, and triaging issues much easier |
| 17 | + |
| 18 | +#### Commit quality code with detailed documentation to help maximize PR review effectiveness |
| 19 | + - All new or modified functionality should have unit tests covering the logic involved |
| 20 | + - All PR checks (e.g. automated tests, code quality analysis, etc.) should be passing before a PR is reviewed |
| 21 | + - Commit messages should be English (Canadian/UK/US are all acceptable) in the present tense using an imperative form (see existing commits for examples) |
| 22 | + - Please do not reference GitHub issue numbers or PR numbers in git commit messages |
| 23 | + |
| 24 | +#### Multiple smaller, atomic PRs are preferable to single larger monolithic PRs |
| 25 | + - This may take longer to get the full changeset merged, but will provide for a much smoother feedback process |
| 26 | + - Please reference any related issue numbers in the body of all PR descriptions so that GitHub links them together |
0 commit comments