Create CONTRIBUTING.md
This commit is contained in:
parent
ebbecdbf78
commit
e20c20e56a
1 changed files with 19 additions and 0 deletions
19
CONTRIBUTING.md
Normal file
19
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
footnotes welcomes contributions!
|
||||||
|
|
||||||
|
Please follow these guidelines when contributing, as it will give your pull request the best chance of being accepted:
|
||||||
|
|
||||||
|
# Branching
|
||||||
|
|
||||||
|
- footnotes uses [GitHub Flow](https://githubflow.github.io/)
|
||||||
|
- branch off of `main` to start developing
|
||||||
|
- give your new branch a descriptive name
|
||||||
|
- when ready, submit a pull request to merge your branch with `main`
|
||||||
|
|
||||||
|
# Commits
|
||||||
|
|
||||||
|
- footnotes uses [Conventional Commits](https://www.conventionalcommits.org)
|
||||||
|
- keep individual commits as small as possible
|
||||||
|
|
||||||
|
# Versioning
|
||||||
|
|
||||||
|
- footnotes uses [Semantic Versioning](https://semver.org/)
|
Reference in a new issue