* Update CONTRIBUTING.md and PR template Closes #2149 * Update wording * Add preferred flow * Clarify pull request submission process Updated the pull request submission instruction to specify creating the PR on GitHub. --------- Co-authored-by: Bernhard Stockmann <stockmann@bitfire.at>
1.6 KiB
Important
Please make sure an issue or discussion for this change exists and was acknowledged by the core team before submitting. Uncoordinated pull requests may conflict with the project roadmap and could be closed without merging — which would be a pity. See CONTRIBUTING.md for details.
Delete this section and other repeating text (like the examples) after reading and before submitting the PR.
The PR should be in Draft state during development. Once finished, mark it as Ready for review and assign a reviewer.
See also: Writing A Great Pull Request Description
Purpose
Describe the purpose of this PR and its benefits.
Example:
Adds support for AAA in BBB, as requested by several people in issue #XX.
Short description
Briefly describe the approach taken to achieve the purpose.
Example:
- Added authentication option Some authentication to some module.
- Added support for Some authentication to some content provider.
- Added UI support for Some authentication in account settings.
Related information (links to Android docs and other resources that help to understand/review the changes) can also be put here.
Checklist
- The PR has a proper title, description and label.
- I have self-reviewed the PR.
- I have added documentation to complex functions and functions that can be used by other modules.
- I have added reasonable tests or consciously decided to not add tests.