diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ffc8229 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +## Contributing + +Pull requests, bug fixes, and new features suggestions, are all welcome! If you have a question or suggestion, you can open a new [issue](https://github.com/mtn/cocoa-eh-hugo-theme/issues/new). Try to be as specific as possible. + +For code changes: + +1. Fork the repository +2. Create a feature branch (`git checkout -b my-new-feature`) +3. Commit a changes (`git commit -am 'Add some feature'`) +4. Push to the remote (`git push origin my-new-feature`) +5. Create new Pull Request on GitHub + +Please keep each pull request to a single feature -- it's okay to submit multiple pull requests at a time! This makes new features easier to review and merge. For large changes, consider making an issue beforehand to discuss. This maximizes the likelihood that your change can be merged quickly and efficiently. diff --git a/README.md b/README.md index 0236543..0dd0b0a 100644 --- a/README.md +++ b/README.md @@ -71,18 +71,6 @@ hugo -t cocoa-eh If you want a simple blog you can just use the `exampleSite`. The [wiki](https://github.com/mtn/cocoa-eh-hugo-theme/wiki) includes helpful details should you need more. -## Contributing - -Pull requests, bug fixes, and new features are welcome! - -1. Fork the repository -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create new Pull Request on GitHub - -Please keep each pull request to a single feature -- it's okay to submit multiple pull requests at a time! This makes new features easier to review and merge. For large changes, consider making an issue beforehand to discuss. - ## License Licensed under the MIT License. See the [LICENSE](https://github.com/mtn/cocoa-eh-hugo-theme/blob/master/LICENSE) file for more details.