-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #84 from Flagsmith/docs/readme-contributing
docs: misc README improvements
- Loading branch information
Showing
2 changed files
with
19 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters