Skip to content

Commit

Permalink
misc: put the changelog reminder on top
Browse files Browse the repository at this point in the history
Since we decided to keep the changelog text file, it needs to be in sync with the changes. That means that a PR usually needs to add a line to it.
  • Loading branch information
shpaass authored Jun 12, 2024
1 parent d987a4e commit 219262a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Docs/ContributorsGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Here are a couple of things to make your experience in the community more enjoya
* In the programmers-haven, there is always a free spot for those who write tests.

## Pull Request
* Please provide a short description of your change in the [changelog](https://github.com/have-fun-was-taken/yafc-ce/blob/master/changelog.txt).
* When making a Pull Request, please give some context. For instance, if the PR solves an issue, then you can put a short description of the issue in the PR.
* If there is no corresponding issue, then describe what the problem was and how your PR fixes it. The context, the state without the fix, and with the fix.
* Please provide a short description of your change in the [changelog](https://github.com/have-fun-was-taken/yafc-ce/blob/master/changelog.txt).
* Make meaningful commit messages. The easier it is to understand your PR, the faster it will be merged.
* It would be appreciated if you reorganize your commits before the merge -- separate and squash them into logical steps, so they are easier to review and understand. For instance, the fixes to the commits can be squashed into them. The reordering of the commits can be done with the interactive rebase: `git rebase -i head~n`, but please read beforehand on how to do it, so you don't accidentally delete your efforts. If you want to go godlike, feel free to read on `git commit --fixup=` and `git rebase -i --autosquash` ([example](https://stackoverflow.com/questions/3103589/how-can-i-easily-fixup-a-past-commit)). However, it can be the case that the reordering requires very tricky merges, so it's okay to leave them as-is in this case.

0 comments on commit 219262a

Please sign in to comment.