Skip to content

Commit 284add3

Browse files
authored
Merge pull request #84 from Flagsmith/docs/readme-contributing
docs: misc README improvements
2 parents 1e89eed + f054e57 commit 284add3

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing
2+
3+
We're always looking to improve this project, open source contribution is encouraged so long as they adhere to these
4+
guidelines.
5+
6+
## Pull Requests
7+
8+
The Flagsmith team will be monitoring for pull requests. When we get one, a member of team will test the work against
9+
our internal uses and sign off on the changes. From here, we'll either merge the pull request or provide feedback
10+
suggesting the next steps.
11+
12+
### A couple things to keep in mind
13+
14+
- If you've changed APIs, update the documentation.
15+
- Keep the code style (indents, wrapping) consistent.
16+
- If your PR involves a lot of commits, squash them using `git rebase -i` as this makes it easier for us to review.
17+
- Keep lines under 80 characters.

Readme.md renamed to README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ The SDK for Python applications for [https://www.flagsmith.com/](https://www.fla
1010
## Adding to your project
1111

1212
For full documentation visit
13-
[https://docs.flagsmith.com/clients/server-side](https://docs.flagsmith.com/clients/server-side).
13+
[https://docs.flagsmith.com/clients/server-side?language=python](https://docs.flagsmith.com/clients/server-side?language=python).
1414

1515
## Contributing
1616

17-
Please read [CONTRIBUTING.md](https://gist.github.com/kyle-ssg/c36a03aebe492e45cbd3eefb21cb0486) for details on our code
17+
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code
1818
of conduct, and the process for submitting pull requests
1919

2020
## Getting Help

0 commit comments

Comments
 (0)