From cf1732d917434bf50ed06a6d4bcf3bf01214b3c8 Mon Sep 17 00:00:00 2001 From: Steven Smith Date: Thu, 1 Aug 2013 21:03:24 +0800 Subject: [PATCH] Adjust terms, change references to 'master' to 'develop', fix links --- CONTRIBUTING.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f867018..45407c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,8 +11,8 @@ The following guidelines for contribution should be followed if you want to subm * Edit the files, add new files * Check the files with [`pep8`](https://pypi.python.org/pypi/pep8), fix any reported errors * 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) -* Commit changes to the branch, push to your fork on GitHub +* Create a new branch with a descriptive name for your feature (optional) +* 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. * 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. @@ -20,7 +20,7 @@ The following guidelines for contribution should be followed if you want to subm ## How to prepare * 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. * 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 @@ -28,21 +28,18 @@ The following guidelines for contribution should be followed if you want to subm ## 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. + * Usually this is based on the develop 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. + fix/develop/my_contribution develop` then checkout the new branch with `git + 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 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. * 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. +* Check your changes with [`pep8`](https://pypi.python.org/pypi/pep8). Ignore messages about line length. ## 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. * 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._