44 lines
1.6 KiB
Markdown
44 lines
1.6 KiB
Markdown
**footnotes** welcomes contributions!
|
||
|
||
Please follow these guidelines when contributing, as it will give your pull
|
||
request the best chance of being accepted:
|
||
|
||
# Requesting Features/Reporting Bugs
|
||
|
||
- To request a new feature or to report a bug, create an [Issue][new-issue] and
|
||
choose the correct template
|
||
|
||
# Contributing Code
|
||
|
||
- **footnotes** uses [GitHub Flow][github-flow]
|
||
- branch off of `main` to start developing (`git checkout -b <your branch>`)
|
||
- ensure that your new branch has a descriptive name
|
||
- create a remote copy of your new branch (`git push`)
|
||
- create a draft [pull request][pull-request] to merge your branch with `main` —
|
||
tag any related Issues, and if they are assigned to a Project board, this will
|
||
automatically move them into the ‘In Progress’ bucket
|
||
- when you think you're finished, un-draft your pull request — if the PR is
|
||
assigned to a Project board, this will automatically move it and any related
|
||
Issues into the ‘Review in progress’ bucket
|
||
|
||
# Commits
|
||
|
||
- **footnotes** uses [Conventional Commits][conventional-commits]
|
||
- we use [PHP Commitizen][php-commitizen] to automate this - use `composer commit`
|
||
- keep individual commits as small as possible
|
||
|
||
# Versioning
|
||
|
||
- **footnotes** uses [Semantic Versioning][semver]
|
||
|
||
# Translating
|
||
|
||
- Translations are welcome!
|
||
|
||
[new-issue]: https://github.com/markcheret/footnotes/issues/new/choose
|
||
[github-flow]: https://githubflow.github.io/
|
||
[pull-request]: https://github.com/markcheret/footnotes/compare
|
||
[conventional-commits]: https://www.conventionalcommits.org
|
||
[php-commitizen]: https://github.com/conventional-commits/php-commitizen
|
||
[semver]: https://semver.org/
|