Skip to content

Commit

Permalink
📝 Expanded style guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
trymzet committed Oct 1, 2021
1 parent bc65dae commit 5b94733
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,8 @@ Please follow the standards and best practices used within the library (eg. when


### Style guidelines
- the code should be formatted with Black (easiest way is to use the VSCode extension)
- commit messages begin with an emoji, then a description starting with one of the following verbs, capitalized: "Added", "Updated", "Removed", "Fixed", and, sporadically, other ones, such as "Upgraded", "Downgraded", or whatever you find relevant for your particular situation
- the code should be formatted with Black using default settings (easiest way is to use the VSCode extension)
- commit messages should:
- begin with an emoji
- start with one of the following verbs, capitalized, immediately after the summary emoji: "Added", "Updated", "Removed", "Fixed", "Renamed", and, sporadically, other ones, such as "Upgraded", "Downgraded", or whatever you find relevant for your particular situation
- contain a useful description of what the commit is doing

0 comments on commit 5b94733

Please sign in to comment.