Skip to content

Commit

Permalink
Update contributing doc with code of conduct and instructions to subm…
Browse files Browse the repository at this point in the history
…it a PR
  • Loading branch information
tinamthomas committed Oct 2, 2019
1 parent dd7b589 commit b539681
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
16 changes: 16 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down

0 comments on commit b539681

Please sign in to comment.