Skip to content

Commit 9ed3cbd

Browse files
authored
Update README.md (#66)
1 parent 087594a commit 9ed3cbd

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,18 @@ Pull Requests and issues are welcome. See the
6868
[NS1 Contribution Guidelines](https://github.com/ns1/community) for more
6969
information.
7070

71+
### Editing the docs
72+
73+
You can create or edit NS1-python documentation by downloading the repo onto your machine and using an editor such as VSCode.
74+
75+
### Creating Pull Requests
76+
77+
1. When you're ready to submit your changes, add a descriptive title and comments to summarize the changes made.
78+
2. Select **Create a new branch for this commit and start a pull request**.
79+
3. Check the **Propose file change** button.
80+
4. Scroll down to compare changes with the original document.
81+
5. Select **Create pull request**.
82+
7183
Our CI process will lint and check for formatting issues with `flake8` and
7284
`black`.
7385
It is suggested to run these checks prior to submitting a pull request and fix

0 commit comments

Comments
 (0)