8000 Minor edits. · GapData/document-api-python@07de383 · GitHub
[go: up one dir, main page]

Skip to content

Commit 07de383

Browse files
authored
Minor edits.
Added a few periods, etc.
1 parent 959efae commit 07de383

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/docs/dev-guide.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,64 +3,64 @@ title: Developer Guide
33
layout: docs
44
---
55

6-
## Making your first patch
6+
## Submitting your first patch
77

88
1. Make sure you have [signed the CLA](http://tableau.github.io/#contributor-license-agreement-cla)
99

10-
1. Fork the repository
10+
1. Fork the repository.
1111

12-
We follow the "Fork and Pull" model as described [here](https://help.github.com/articles/about-collaborative-development-models/)
12+
We follow the "Fork and Pull" model as described [here](https://help.github.com/articles/about-collaborative-development-models/).
1313

14-
1. Clone your fork
14+
1. Clone your fork:
1515

1616
```shell
1717
git clone http://github.com/<your_username>/document-api-python
1818
```
1919

20-
1. Run the tests to make sure everything is peachy
20+
1. Run the tests to make sure everything is peachy:
2121

2222
```shell
2323
python setup.py test
2424
```
2525

2626
1. Set up the feature, fix, or documentation branch.
2727

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:
2929

3030
```shell
3131
git checkout -b 13-feature-new-stuff
3232
```
3333

34-
1. Code and Commit!
34+
1. Code and commit!
3535

3636
Here's a quick checklist for ensuring a good pull request:
3737

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.
4040
- 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.
4343

44-
1. Add Tests
44+
1. Add tests.
4545

4646
All of our tests live under the `test/` folder in the repository.
4747
We use `unittest` and the built-in test runner `python setup.py test`.
4848
If a test needs a static file, like a twb/twbx, it should live under `test/assets/`
4949

50-
1. Update Documentation
50+
1. Update the documentation.
5151

5252
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`.
5353

5454
When adding a new feature or improving existing functionality we may ask that you update the documentation along with your code.
5555

5656
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
5757

58-
1. Submit to your fork
58+
1. Submit to your fork.
5959

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.
6161

6262
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.
6464

6565
1. That's it! When the PR has received :rocket:'s from members of the core team they will merge the PR
6666

0 commit comments

Comments
 (0)
0