aniani/profanity
1
0
Fork 0
mirror of https://github.com/profanity-im/profanity.git synced 2024-12-04 14:46:46 -05:00
Code

Add commit info to CONTRIBUTING.md

Browse Source
This commit is contained in:
Michael Vetter 2022-10-10 08:05:11 +02:00
parent 4b2bbe59ea
commit a0f8adc681
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -16,6 +16,11 @@ When working on a new feature we usually use `git checkout -b feature/optionalis
However this is not a rule just a recommendation to keep an overview of things. However this is not a rule just a recommendation to keep an overview of things.
If your change isn't a bugfix or new feature you can also just use any branch name. If your change isn't a bugfix or new feature you can also just use any branch name.
## Commit messages
Write commit messages that make sense. Explain what and *why* you change.
Write in present tense.
Please give [this guideline](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53) a read.
### GitHub ### GitHub
We would like to encourage people to use GitHub to create pull requests. We would like to encourage people to use GitHub to create pull requests.
It makes it easy for us to review the patches, track WIP branches, organize branches with labels and milestones, It makes it easy for us to review the patches, track WIP branches, organize branches with labels and milestones,
@ -46,6 +51,7 @@ We will then pull from your repository and merge manually.
* Each patch or pull request should only contain related modifications. * Each patch or pull request should only contain related modifications.
* Run the tests and code formatters before submitting (c.f. Chapter 'Check everything' of this README). * Run the tests and code formatters before submitting (c.f. Chapter 'Check everything' of this README).
* When changing the UI it would be appreciated if you could add a before and after screenshot for comparison. * When changing the UI it would be appreciated if you could add a before and after screenshot for comparison.
* Squash fixup commits into one
### Hints and Pitfalls ### Hints and Pitfalls