From 481a686ce175d753ad07c1b201fe6dfd4b7e88d4 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Wed, 13 Nov 2019 16:01:21 +0100 Subject: [PATCH] Add CONTRIBUTING --- .github/CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..c9326766 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,28 @@ +## Contributing + +Hi there! I'm thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. + +Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](../LICENSE). + +## Submitting a pull request + +1. [Fork](https://github.com/crazy-max/diun/fork) and clone the repository +2. Configure and install the dependencies: `go mod download` +3. Create a new branch: `git checkout -b my-branch-name` +4. Make your change +5. Build your code with [GoReleaser](https://goreleaser.com/): `goreleaser release --skip-publish --skip-validate --rm-dist` +6. Push to your fork and [submit a pull request](https://github.com/crazy-max/diun/compare) +7. Pat your self on the back and wait for your pull request to be reviewed and merged. + +Here are a few things you can do that will increase the likelihood of your pull request being accepted: + +* Make sure the `README.md` and any other relevant **documentation are kept up-to-date**. +* I try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option. +* Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as **separate pull requests**. +* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). + +## Resources + +* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) +* [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) +* [GitHub Help](https://help.github.com)