From 24857230971f6be790ca25a6b95fc7f997799290 Mon Sep 17 00:00:00 2001 From: Jordan Knott Date: Tue, 18 Aug 2020 16:19:10 -0500 Subject: [PATCH] docs: add contributing guide --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5773d3c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +## Contributing + +Thanks for wanting to contribute to Taskcafe! + +### Where do I go from here? + +If you have noticed a bug or have a feature request, make one! If best to get confirmation +of your bug or feature before starting work on a pull request. + +### Fork & create a branch + +If there is something you want to fix or add, the first step is to fork this repository. + +Next is to create a new branch with an appropriate name. The general format that should be used is + +``` +git checkout -b '/' +``` + +The `type` is the same as the `type` that you will use for [your commit message](https://www.conventionalcommits.org/en/v1.0.0/#summary). + +The `description` is a decriptive summary of the change the PR will make. + +### General Rules + +- All PRs should be rebased (with master) and commits squashed prior to the final merge process + +### Git Commit Message Style + +This project uses the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) format. + +Example commit messages: + +``` +chore: update gqlgen dependency to v2.6.0 +docs(README): add new contributing section +fix: remove debug log statements +```