2021-02-21 13:53:51 +00:00
**footnotes** welcomes contributions!
2021-02-20 19:04:22 +00:00
2021-02-21 13:53:51 +00:00
Please follow these guidelines when contributing, as it will give your pull
request the best chance of being accepted:
2021-02-20 19:04:22 +00:00
2021-02-21 13:53:51 +00:00
# Requesting Features/Reporting Bugs
2021-02-20 19:04:22 +00:00
2021-02-21 13:53:51 +00:00
- To request a new feature or to report a bug, create an
[Issue ](https://github.com/markcheret/footnotes/issues/new/choose ) and choose
2021-02-21 13:55:22 +00:00
the correct template
2021-02-21 13:53:51 +00:00
# Contributing Code
- **footnotes** uses [GitHub Flow ](https://githubflow.github.io/ )
- 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 ](https://github.com/markcheret/footnotes/compare )
to merge your branch with `main` — tag any related Issues, and if they are
2021-02-21 13:55:22 +00:00
assigned to a Project board, this will automatically move them into the
‘ In Progress’ bucket
2021-02-21 13:53:51 +00:00
- when you think you're finished, un-draft your pull request — if the PR is
2021-02-21 13:55:22 +00:00
assigned to a Project board, this will automatically move it and any related
Issues into the ‘ Review in progress’ bucket
2021-02-20 19:04:22 +00:00
# Commits
2021-02-21 13:53:51 +00:00
- **footnotes** uses [Conventional Commits ](https://www.conventionalcommits.org )
2021-02-20 19:04:22 +00:00
- keep individual commits as small as possible
# Versioning
2021-02-21 13:53:51 +00:00
- **footnotes** uses [Semantic Versioning ](https://semver.org/ )
# Translating
- Translations are welcome!