diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..73fa4de --- /dev/null +++ b/CONTRIBUTING.md @@ -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/)