From b5396813989521f24a4eaa60b91264a712b1000c Mon Sep 17 00:00:00 2001 From: Tina Maria Thomas Date: Tue, 1 Oct 2019 21:35:58 -0400 Subject: [PATCH] Update contributing doc with code of conduct and instructions to submit a PR --- README.md | 4 ++++ contributing.md | 16 ++++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/README.md b/README.md index 1f6a4288..ed18aff6 100644 --- a/README.md +++ b/README.md @@ -448,3 +448,7 @@ This will When you installed Talisman, it must have created a pre-commit or pre-push hook (as selected) in your repository during installation. You can remove the hook manually by deleting the Talisman pre-commit or pre-push hook from .git/hooks folder in repository. + +## Contributing to Talisman + +To contribute to Talisman, have a look at our [contributing guide](contributing.md). diff --git a/contributing.md b/contributing.md index b7006ed9..f27dd07e 100644 --- a/contributing.md +++ b/contributing.md @@ -1,5 +1,11 @@ # Contributing to Talisman +By contributing to Talisman, you agree to abide by the [code of conduct](CODE_OF_CONDUCT.md). + +## How to start contributing + +If you are not sure how to begin contributing to Talisman, have a look at the issues tagged under [good first issue](https://github.com/thoughtworks/talisman/labels/good%20first%20issue). + ## Developing locally To contribute to Talisman, you need a working golang development @@ -22,6 +28,16 @@ To build Talisman, we can use [gox](https://github.com/mitchellh/gox): Convenience scripts ```./build``` and ```./clean``` perform build and clean-up as mentioned above. +## Submitting a Pull Request + +To send in a pull request + +1. Fork the repo. +2. Create a new feature branch based off the master branch. +3. Provide the commit message with the the issue number and a proper description. +4. Ensure that all the tests pass. +5. Submit the pull request. + ## Releasing * Follow the instructions at the end of 'Developing locally' to build the binaries