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
1. Run the tests to make sure everything is peachy
@@ -21,33 +25,44 @@ layout: docs
21
25
22
26
1. Set up the feature, fix, or documentation branch.
23
27
24
-
It is recommended to use the format [issue#]-[type]-[description] (e.g. 13-fix-connection-bug)
28
+
It is recommended to use the format issue#-type-description (e.g. 13-fix-connection-bug)
25
29
26
30
```shell
27
31
git checkout -b 13-feature-new-stuff
28
32
```
29
33
30
34
1. Code and Commit!
31
35
32
-
Here's a quick checklist for ensuring a good diff:
36
+
Here's a quick checklist for ensuring a good pull request:
33
37
34
-
- The diff touches the minimal amount of files possible while still fufilling the purpose of the diff
35
-
- The diff uses Unix line endings
36
-
- The diff adheres to our PEP8 style guides. If you've cloned the repo you can run `pycodestyle .`
38
+
- Only touch the minimal amount of files possible while still accomplishing the goal
39
+
- Ensure all indentation is done as 4-spaces and your editor is set to unix line endings
40
+
- The code matches PEP8 style guides. If you cloned the repo you can run `pycodestyle .`
41
+
- Keep commit messages clean and descriptive.
42
+
If the PR is accepted it will get 'Squashed' into a single commit before merging, the commit messages will be used to generate the Merge commit message
37
43
38
44
1. Add Tests
39
45
46
+
All of our tests live under the `test/` folder in the repository.
47
+
We use `unittest` and the built-in test runner `python setup.py test`.
48
+
If a test needs a static file, like a twb/twbx, it should live under `test/assets/`
49
+
40
50
1. Update Documentation
41
51
42
-
Our documentation is written in markdown and built with [Mkdocs](http://www.mkdocs.org). More information on how to update and build the docs can be found [here](#updating-documentation)
52
+
Our documentation is written in markdown and built with Jekyll on Github Pages. All of the documentation source files can be found in `docs/docs`.
43
53
44
-
1. Run the tests again and make sure they pass!
54
+
When adding a new feature or improving existing functionality we may ask that you update the documentation along with your code.
55
+
56
+
If you are just making a PR for documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built in `Edit this file` in the Github UI
45
57
46
58
1. Submit to your fork
47
59
48
-
1. Submit a PR
60
+
1. Make a PR as described [here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the 'development' branch
61
+
62
+
1. Wait for a review and address any feedback.
63
+
While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely pinging the PR after a few days with no response is OK, we'll try and respond with a timeline as soon as we are able
49
64
50
-
1.Wait for a review, and address any feedback.
65
+
1.That's it! When the PR has received :rocket:'s from members of the core team they will merge the PR
0 commit comments