Adjust terms, change references to 'master' to 'develop', fix links
This commit is contained in:
parent
65a1827004
commit
cf1732d917
|
@ -11,8 +11,8 @@ The following guidelines for contribution should be followed if you want to subm
|
||||||
* Edit the files, add new files
|
* Edit the files, add new files
|
||||||
* Check the files with [`pep8`](https://pypi.python.org/pypi/pep8), fix any reported errors
|
* Check the files with [`pep8`](https://pypi.python.org/pypi/pep8), fix any reported errors
|
||||||
* Check that the files work as expected in CloudBot
|
* Check that the files work as expected in CloudBot
|
||||||
* Create a new branch with a descriptive name for your feature (don't use `develop` for changes)
|
* Create a new branch with a descriptive name for your feature (optional)
|
||||||
* Commit changes to the branch, push to your fork on GitHub
|
* Commit changes, push to your fork on GitHub
|
||||||
* Create a new pull request, provide a short summary of changes in the title line, with more information in the description field.
|
* Create a new pull request, provide a short summary of changes in the title line, with more information in the description field.
|
||||||
* After submitting the pull request, join the IRC channel (irc.esper.net #cloudbot) and paste a link to the pull request so people are aware of it
|
* After submitting the pull request, join the IRC channel (irc.esper.net #cloudbot) and paste a link to the pull request so people are aware of it
|
||||||
* After discussion, your pull request will be accepted or rejected.
|
* After discussion, your pull request will be accepted or rejected.
|
||||||
|
@ -20,7 +20,7 @@ The following guidelines for contribution should be followed if you want to subm
|
||||||
## How to prepare
|
## How to prepare
|
||||||
|
|
||||||
* You need a [GitHub account](https://github.com/signup/free)
|
* You need a [GitHub account](https://github.com/signup/free)
|
||||||
* Submit an [issue ticket](https://github.com/anselmh/modx-boilerplate-evo/issues) for your issue if the is no one yet.
|
* Submit an [issue ticket](https://github.com/ClouDev/CloudBot/issues) for your issue if the is no one yet.
|
||||||
* Describe the issue and include steps to reproduce if it's a bug.
|
* Describe the issue and include steps to reproduce if it's a bug.
|
||||||
* Ensure to mention the earliest version that you know is affected.
|
* 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
|
* If you are able and want to fix this, fork the repository on GitHub
|
||||||
|
@ -28,21 +28,18 @@ The following guidelines for contribution should be followed if you want to subm
|
||||||
## Make Changes
|
## Make Changes
|
||||||
|
|
||||||
* In your forked repository, create a topic branch for your upcoming patch. (e.g. `feature--autoplay` or `bugfix--ios-crash`)
|
* 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.
|
* Usually this is based on the develop branch.
|
||||||
* Create a branch based on master; `git branch
|
* Create a branch based on master; `git branch
|
||||||
fix/master/my_contribution master` then checkout the new branch with `git
|
fix/develop/my_contribution develop` then checkout the new branch with `git
|
||||||
checkout fix/master/my_contribution`. Please avoid working directly on the `master` branch.
|
checkout fix/develop/my_contribution`. Please avoid working directly on the `develop` branch.
|
||||||
* Make sure you stick to the coding style that is used already.
|
* Make sure you stick to the coding style that is used already.
|
||||||
* Make use of the [`.editorconfig`-file](http://editorconfig.org/) if provided with the repository.
|
* Make use of the [`.editorconfig`](http://editorconfig.org/) file.
|
||||||
* Make commits of logical units and describe them properly.
|
* Make commits of logical units and describe them properly.
|
||||||
* Check for unnecessary whitespace with `git diff --check` before committing.
|
* Check for unnecessary whitespace with `git diff --check` before committing.
|
||||||
|
* Check your changes with [`pep8`](https://pypi.python.org/pypi/pep8). Ignore messages about line length.
|
||||||
* 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
|
## Submit Changes
|
||||||
|
|
||||||
* Check your changes with [`pep8`](https://pypi.python.org/pypi/pep8). Ignore messages about line length, .
|
|
||||||
* Push your changes to a topic branch in your fork of the repository.
|
* 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.
|
* Open a pull request to the original repository and choose the right original branch you want to patch.
|
||||||
_Advanced users may use [`hub`](https://github.com/defunkt/hub#git-pull-request) gem for that._
|
_Advanced users may use [`hub`](https://github.com/defunkt/hub#git-pull-request) gem for that._
|
||||||
|
|
Reference in New Issue