Skip to content

Commit

Permalink
Clarify pull request template
Browse files Browse the repository at this point in the history
  • Loading branch information
ferki committed Feb 10, 2025
1 parent 78049a6 commit 20989ce
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<!-- Thanks for contributing to Rex! -->
<!-- For optimal workflow, please make sure you have read and understood the [Contributing guide](https://github.com/RexOps/Rex/blob/master/CONTRIBUTING.md). -->
<!-- Please read and follow our [Contributing guide](https://github.com/RexOps/Rex/blob/master/CONTRIBUTING.md). -->

<!-- TL; DR: -->
<!-- Make sure there's an issue where the proposed changes are already discussed. -->
<!-- Please open the pull request as a draft first, and wait for automated test results. -->
<!-- Feel free to work on the PR till tests pass, and the checklist below is complete, then mark it ready for review. -->
<!-- Discussions first, issues next, pull requests last. -->
<!-- Consider opening a draft pull request, and wait for automated test results. -->
<!-- Work on the pull request until all tests pass, checking all entries below, then mark it ready for review. -->

This PR is a proposal to fix #<!-- issue ID --> by <!-- briefly explaining your changes -->.
This pull request proposes to fix #<!-- issue ID --> by <!-- briefly explaining the changes -->.

<!-- Ideally, ask for a specific expected course of action, like: -->
<!-- Please review and merge, or let me know how to improve it further. -->
<!-- Ask for a specific expected course of action, like: -->
<!-- Please review, then either merge, or let me know how to improve it further. -->

## Checklist
## Checklist towards merging

- [ ] based on top of latest source code <!-- Make sure your changes are based on the latest version of the source code, rebase your branch if necessary. -->
- [ ] changelog entry included <!-- If the change is interesting for the users or developers, it should be mentioned in the changelog. -->
- [ ] automated tests pass <!-- Demonstrate the code is solid. Include new tests first, let them fail, then push the fix, allowing tests to pass. -->
- [ ] git history is clean <!-- Ideally two commits are needed: one for adding new tests that fail, and one that fixes them. -->
- [ ] git commit messages are [well-written](https://chris.beams.io/posts/git-commit/#seven-rules)
- [ ] (re)based on top of latest source code <!-- (Re)base the changes on top of the latest commits of the default branch.-->
- [ ] has changelog entry <!-- Mention user-facing changes in the changelog. -->
- [ ] automated tests pass <!-- Demonstrate solid changes. Push new tests first, let them fail, then push the fix, making test pass. -->
- [ ] has clean git history <!-- Ideally two commits: one to add new tests that fail, and one that makes them pass. -->
- [ ] has [well-written](https://chris.beams.io/posts/git-commit/#seven-rules) commit messages

0 comments on commit 20989ce

Please sign in to comment.