Skip to content

Commit e0ea747

Browse files
committed
Merge remote-tracking branch 'origin/python3.4' into python3.4
2 parents 72eb307 + fea19d0 commit e0ea747

1 file changed

Lines changed: 11 additions & 16 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# How to contribute
22

3-
I like to encourage you to contribute to the repository.
3+
Heya, Luke here. It's awesome that you want to help contribute to CloudBot!
44
This should be as easy as possible for you but there are a few things to consider when contributing.
5-
The following guidelines for contribution should be followed if you want to submit a pull request.
65

7-
## TL;DR
6+
The following guidelines for contribution should be followed if you want to submit a pull request. If you have any troubles, just come and ask us for help on our IRC channel.
7+
8+
## Basic Overview
89

910
* Read [Github documentation](http://help.github.com/) and [Pull Request documentation](http://help.github.com/send-pull-requests/)
1011
* Fork the repository
@@ -14,38 +15,32 @@ The following guidelines for contribution should be followed if you want to subm
1415
* Create a new branch with a descriptive name for your feature (optional)
1516
* Commit changes, push to your fork on GitHub
1617
* Create a new pull request, provide a short summary of changes in the title line, with more information in the description field.
17-
* 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
18+
* After submitting the pull request, join the IRC channel (irc.esper.net #cloudbot) and give us a link so we know you submitted it.
1819
* After discussion, your pull request will be accepted or rejected.
1920

2021
## How to prepare
2122

2223
* You need a [GitHub account](https://github.com/signup/free)
23-
* Submit an [issue ticket](https://github.com/ClouDev/CloudBot/issues) for your issue if the is no one yet.
24-
* Describe the issue and include steps to reproduce if it's a bug.
25-
* Ensure to mention the earliest version that you know is affected.
24+
* Submit an [issue ticket](https://github.com/ClouDev/CloudBot/issues) for your issue if there is no one yet.
25+
* Try to describe the issue and include steps to reproduce if it's a bug.
2626
* If you are able and want to fix this, fork the repository on GitHub
2727

2828
## Make Changes
2929

30-
* In your forked repository, create a topic branch for your upcoming patch. (e.g. `feature--autoplay` or `bugfix--ios-crash`)
31-
* Usually this is based on the develop branch.
32-
* Create a branch based on master; `git branch
33-
fix/develop/my_contribution develop` then checkout the new branch with `git
34-
checkout fix/develop/my_contribution`. Please avoid working directly on the `develop` branch.
30+
* In your forked repository, create a topic branch for your upcoming patch. (optional)
3531
* Make sure you stick to the coding style that is used already.
3632
* Make use of the [`.editorconfig`](http://editorconfig.org/) file.
37-
* Make commits of logical units and describe them properly.
33+
* Make commits that make sense and describe them properly.
3834
* Check for unnecessary whitespace with `git diff --check` before committing.
39-
* Check your changes with [`pep8`](https://pypi.python.org/pypi/pep8). Ignore messages about line length.
35+
* Check your changes with [`pep8`](https://pypi.python.org/pypi/pep8). You can usually ignore messages about line length, but we like to keep lines shorter then 120 characters if at all possible.
4036

4137
## Submit Changes
4238

4339
* Push your changes to a topic branch in your fork of the repository.
44-
* Open a pull request to the original repository and choose the right original branch you want to patch.
40+
* Open a pull request to the original repository and choose the `python3.4` branch.
4541
_Advanced users may use [`hub`](https://github.com/defunkt/hub#git-pull-request) gem for that._
4642
* 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_.
4743
_Notice: You can [turn your previously filed issues into a pull-request here](http://issue2pr.herokuapp.com/)._
48-
* 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.
4944

5045
# Additional Resources
5146

0 commit comments

Comments
 (0)