From 4f1eca5fa5b272ad9ccd52ee27dc89ee39c6b319 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Wed, 23 Oct 2019 14:22:04 +0200 Subject: [PATCH] Add CONTRIBUTING.md --- .github/CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..e8d86a7 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,30 @@ +## Contributing + +Hi there! We're 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/ghaction-github-pages/fork) and clone the repository +2. Configure and install the dependencies: `npm install` +4. Create a new branch: `git checkout -b my-branch-name` +5. Make your change +6. Compile your Typescript code: `npm run build` +7. Format your code: `npm run format` +8. Prune dependencies: `npm prune --production` +9. Push to your fork and [submit a pull request](https://github.com/crazy-max/ghaction-github-pages/compare) +10. 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**. +- We 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)