From 8655c7a3c5dd0d72f7715159ecb6dc5f4b0d4c2b Mon Sep 17 00:00:00 2001 From: Meet Zaveri Date: Wed, 4 Oct 2017 09:09:15 +0530 Subject: [PATCH 1/2] Create CONTRIBUTING.md --- CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1cf86c7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# How to contribute + +I like to encourage you to contribute to the repository. +This should be as easy as possible for you but there are a few things to consider when contributing. +The following guidelines for contribution should be followed if you want to submit a pull request. + +## How to prepare + +* You need a [GitHub account](https://github.com/signup/free) +* Submit an [issue ticket](https://github.com/anselmh/CONTRIBUTING.md/issues) for your issue if there is no one yet. +* Describe the issue and include steps to reproduce if it's a bug. +* Ensure to mention the earliest version that you know is affected. +* If you are able and want to fix this, fork the repository on GitHub + +## Make Changes + +* In your forked repository, create a topic branch for your upcoming patch. (e.g. `feature--autoplay` or `bugfix--ios-crash`) +* Usually this is based on the master branch. +* Create a branch based on master; `git branch + fix/master/my_contribution master` then checkout the new branch with `git + checkout fix/master/my_contribution`. Please avoid working directly on the `master` branch. +* Make sure you stick to the coding style that is used already. +* Make use of the `.editorconfig`-file if provided with the repository. +* Make commits of logical units and describe them properly. +* Check for unnecessary whitespace with `git diff --check` before committing. + +* If possible, submit tests to your patch / new feature so it can be tested easily. +* Assure nothing is broken by running all the tests. + +## Submit Changes + +* Push your changes to a topic branch in your fork of the repository. +* Open a pull request to the original repository and choose the right original branch you want to patch. + _Advanced users may install the `hub` gem and use the [`hub pull-request` command](https://hub.github.com/hub.1.html)._ +* If not done in commit messages (which you really should do) please reference and update your issue with the code changes. But _please do not close the issue yourself_. +_Notice: You can [turn your previously filed issues into a pull-request here](http://issue2pr.herokuapp.com/)._ +* Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve. + ++# Additional Resources + +* [General GitHub documentation](http://help.github.com/) +* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/) +* [Read the Issue Guidelines by @necolas](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md) for more details From aa98e868fb6466855440fb6b48c6a7fc7ecd962e Mon Sep 17 00:00:00 2001 From: Meet Zaveri Date: Wed, 4 Oct 2017 17:13:45 +0530 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1cf86c7..04a0591 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,7 @@ The following guidelines for contribution should be followed if you want to subm _Notice: You can [turn your previously filed issues into a pull-request here](http://issue2pr.herokuapp.com/)._ * Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve. -+# Additional Resources +# Additional Resources * [General GitHub documentation](http://help.github.com/) * [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)