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
20
+
1. Run the tests to make sure everything is peachy:
21
21
22
22
```shell
23
23
python setup.py test
24
24
```
25
25
26
26
1. Set up the feature, fix, or documentation branch.
27
27
28
-
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) like so:
29
29
30
30
```shell
31
31
git checkout -b 13-feature-new-stuff
32
32
```
33
33
34
-
1. Code and Commit!
34
+
1. Code and commit!
35
35
36
36
Here's a quick checklist for ensuring a good pull request:
37
37
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
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
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
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.
43
43
44
-
1. Add Tests
44
+
1. Add tests.
45
45
46
46
All of our tests live under the `test/` folder in the repository.
47
47
We use `unittest` and the built-in test runner `python setup.py test`.
48
48
If a test needs a static file, like a twb/twbx, it should live under `test/assets/`
49
49
50
-
1. Update Documentation
50
+
1. Update the documentation.
51
51
52
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`.
53
53
54
54
When adding a new feature or improving existing functionality we may ask that you update the documentation along with your code.
55
55
56
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
57
57
58
-
1. Submit to your fork
58
+
1. Submit to your fork.
59
59
60
-
1. Make a PR as described [here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the 'development' branch
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
61
62
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
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.
64
64
65
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