diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 871b955957..68aaa94b73 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,16 +46,17 @@ The FreeCAD Contribution Process is expressed here with the following specific g ## 5. Contribution Requirements 1. Contributions are submitted in the form of Pull Requests (PR). -2. Maintainers and Contributors MUST have a Platform account and SHOULD use their real names or a well-known alias. If the Platform alias differs from the account alias on the FreeCAD Forum, effort SHOULD be taken to avoid confusion. -3. A PR SHOULD be a minimal and accurate answer to exactly one identified and agreed-on problem. -4. A PR SHOULD refrain from adding additional dependencies to the FreeCAD project unless no other option is available. -5. Code submissions MUST adhere to the code style guidelines of the project if these are defined. -6. If a PR contains multiple commits, each commit MUST compile cleanly when merged with all previous commits of the same PR. Each commit SHOULD add value to the history of the project. Checkpoint commits SHOULD be squashed. -7. A PR SHALL NOT include non-trivial code from other projects unless the Contributor is the original author of that code. -8. A PR MUST compile cleanly and pass project self-tests on all target Platforms. -9. Each commit message in a PR MUST succinctly explain what the commit achieves. The commit message SHALL follow the suggestions in the `git commit --help` documentation, section DISCUSSION. -10. The PR message MUST consist of a single short line, the PR Title, summarizing the problem being solved, followed by a blank line and then the proposed solution in the Body. If a PR consists of more than one commit, the PR Title MUST succinctly explain what the PR achieves. The Body MAY be as detailed as needed. -11. A “Valid PR” is one which satisfies the above requirements. +2. Maintainers and Contributors MUST have a Platform account and SHOULD use their real names or a well-known alias. +3. If the Platform alias differs from the account alias on the FreeCAD Forum, effort SHOULD be taken to avoid confusion. +4. A PR SHOULD be a minimal and accurate answer to exactly one identified and agreed-on problem. +5. A PR SHOULD refrain from adding additional dependencies to the FreeCAD project unless no other option is available. +6. Code submissions MUST adhere to the code style guidelines of the project if these are defined. +7. If a PR contains multiple commits, each commit MUST compile cleanly when merged with all previous commits of the same PR. Each commit SHOULD add value to the history of the project. Checkpoint commits SHOULD be squashed. +8. A PR SHALL NOT include non-trivial code from other projects unless the Contributor is the original author of that code. +9. A PR MUST compile cleanly and pass project self-tests on all target Platforms. +10. Each commit message in a PR MUST succinctly explain what the commit achieves. The commit message SHALL follow the suggestions in the `git commit --help` documentation, section DISCUSSION. +11. The PR message MUST consist of a single short line, the PR Title, summarizing the problem being solved, followed by a blank line and then the proposed solution in the Body. If a PR consists of more than one commit, the PR Title MUST succinctly explain what the PR achieves. The Body MAY be as detailed as needed. +12. A “Valid PR” is one which satisfies the above requirements. ## 6. Process