Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: tweak contributing guide

Browse source
This commit is contained in:
Ben Goldsworthy 2021-04-24 09:16:32 +01:00
parent 6569656dc4
commit ae9881deba
1 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
CONTRIBUTING.md
View file

@ -1,14 +1,17 @@
# **footnotes** Contributing Guide
**footnotes** welcomes contributions! **footnotes** welcomes contributions!
Please follow these guidelines when contributing, as it will give your pull ## Code of Conduct
request the best chance of being accepted:
# Requesting Features/Reporting Bugs Please read and adhere to the project [Code of Conduct][coc].
## Requesting Features/Reporting Bugs
- To request a new feature or to report a bug, create an [Issue][new-issue] and - To request a new feature or to report a bug, create an [Issue][new-issue] and
choose the correct template choose the correct template
# Contributing Code ## Contributing Code
- **footnotes** uses [GitHub Flow][github-flow] - **footnotes** uses [GitHub Flow][github-flow]
- branch off of `main` to start developing (`git checkout -b <your branch>`) - branch off of `main` to start developing (`git checkout -b <your branch>`)
@ -21,20 +24,21 @@ request the best chance of being accepted:
assigned to a Project board, this will automatically move it and any related assigned to a Project board, this will automatically move it and any related
Issues into the ‘Review in progress’ bucket Issues into the ‘Review in progress’ bucket
# Commits ## Commits
- **footnotes** uses [Conventional Commits][conventional-commits] - **footnotes** uses [Conventional Commits][conventional-commits]
- we use [PHP Commitizen][php-commitizen] to automate this - use `composer commit` - we use [PHP Commitizen][php-commitizen] to automate this - use `composer commit`
- keep individual commits as small as possible - keep individual commits as small as possible
# Versioning ## Versioning
- **footnotes** uses [Semantic Versioning][semver] - **footnotes** uses [Semantic Versioning][semver]
# Translating ## Translating
- Translations are welcome! - Translations are welcome!
[coc]: https://github.com/markcheret/footnotes/blob/main/CODE_OF_CONDUCT.md
[new-issue]: https://github.com/markcheret/footnotes/issues/new/choose [new-issue]: https://github.com/markcheret/footnotes/issues/new/choose
[github-flow]: https://githubflow.github.io/ [github-flow]: https://githubflow.github.io/
[pull-request]: https://github.com/markcheret/footnotes/compare [pull-request]: https://github.com/markcheret/footnotes/compare