You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-16Lines changed: 11 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,11 @@
1
1
# How to contribute
2
2
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!
4
4
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.
6
5
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
8
9
9
10
* Read [Github documentation](http://help.github.com/) and [Pull Request documentation](http://help.github.com/send-pull-requests/)
10
11
* Fork the repository
@@ -14,38 +15,32 @@ The following guidelines for contribution should be followed if you want to subm
14
15
* Create a new branch with a descriptive name for your feature (optional)
15
16
* Commit changes, push to your fork on GitHub
16
17
* 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.
18
19
* After discussion, your pull request will be accepted or rejected.
19
20
20
21
## How to prepare
21
22
22
23
* 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.
26
26
* If you are able and want to fix this, fork the repository on GitHub
27
27
28
28
## Make Changes
29
29
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)
35
31
* Make sure you stick to the coding style that is used already.
36
32
* 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.
38
34
* 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.
40
36
41
37
## Submit Changes
42
38
43
39
* 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.
45
41
_Advanced users may use [`hub`](https://github.com/defunkt/hub#git-pull-request) gem for that._
46
42
* 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_.
47
43
_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.
0 commit comments