Skip to content

Commit

Permalink
Merge pull request #84 from Flagsmith/docs/readme-contributing
Browse files Browse the repository at this point in the history
docs: misc README improvements
  • Loading branch information
rolodato authored Apr 23, 2024
2 parents 1e89eed + f054e57 commit 284add3
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing

We're always looking to improve this project, open source contribution is encouraged so long as they adhere to these
guidelines.

## Pull Requests

The Flagsmith team will be monitoring for pull requests. When we get one, a member of team will test the work against
our internal uses and sign off on the changes. From here, we'll either merge the pull request or provide feedback
suggesting the next steps.

### A couple things to keep in mind

- If you've changed APIs, update the documentation.
- Keep the code style (indents, wrapping) consistent.
- If your PR involves a lot of commits, squash them using `git rebase -i` as this makes it easier for us to review.
- Keep lines under 80 characters.
4 changes: 2 additions & 2 deletions Readme.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ The SDK for Python applications for [https://www.flagsmith.com/](https://www.fla
## Adding to your project

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

## Contributing

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

## Getting Help
Expand Down

0 comments on commit 284add3

Please sign in to comment.