Skip to content

Commit

Permalink
docs(contributing): make Commits section up-to-date
Browse files Browse the repository at this point in the history
* Conventional Commits as the preferred way for commit messages

* remove emojis section
  * emojis have their [cons](https://engineeringfordatascience.com/posts/gitmoji/#cons)
  * emojis relying on a font have even more cons
  * even the original author dropped their usage in this project
  • Loading branch information
pbodnar committed Jan 15, 2023
1 parent 542c010 commit 2aef3b7
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,29 +53,31 @@ comments.

## Writing code

### Commit messages
### Atomic commits

* minimal cosmetic changes are fine to mix in with your commits, but try feel
guilty when you do that, and if it's not too big of a hassle, break them
into two commits.

* give clear, instructive commit messages. Try using phrases like "added XXX
feature" or "fixed XXX (#42)".
* similarly, provided there occur bigger, independent areas of changes you
would like to address in a pull request, it may be a good idea to split
your pull request into multiple ones.

### Commit messages

* if you find yourself cramming too many things into one commit message, you
should probably break them into multiple commits.
* give clear, instructive commit messages.
[Conventional Commits](conv-commits) is the preferred way of how to
structure a commit message.

* emojis are awesome. Use them like this:
* here is an example commit message when fixing some stuff from a numbered
issue: `fix: avoid infinite loop when parsing specific Footnotes (#124)`.

| Emoji | Description |
| :---: | :------------------------------ |
| 📚 | Update documentation. |
| 🐎 | Performance improvements. |
| 💡 | New features. |
| 🐛 | Bug fixes. |
| 🚨 | Under construction. |
| ☕️ | Refactoring / cosmetic changes. |
| 🌎 | Internationalization. |
* find 5 minutes of your time to add important non-obvious details
to the message body, like WHY or HOW.
This can tremendously reduce the time necessary to investigate future issues
and to get better understanding of the project code for newbies.
(Yet, this should not serve as a replacement for proper documentation or
inline comments.)

### Style guide

Expand Down Expand Up @@ -107,3 +109,4 @@ I tweet [@mi_before_yu][twitter]. Also yell at me over [email][email].
[pep-8]: https://www.python.org/dev/peps/pep-0008/
[twitter]: https://twitter.com/mi_before_yu
[email]: mailto:hello@afteryu.me
[conv-commits]: https://www.conventionalcommits.org/

0 comments on commit 2aef3b7

Please sign in to comment.