Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Restioson authored May 13, 2018
1 parent 7836a3b commit a7d25f9
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,30 @@ You can also get builds from [Flower's CI/CD](https://ci.gegy1000.net/job/Flower

## Contributing

If you wish to PR something to Flower, thanks so much! Just note to please **pull request into development, not master**.
If you wish to PR something to Flower, thanks so much! Just note to please **pull request into development, not master**
if you are making a change to the codebase.

Generally, the workflow for submitting a pull request goes like this:

1. Open an issue that your PR aims to solve and request to be assigned. This is just so we don't have multiple people working on
the same thing on different branches/forks.
2. Fork flower
3. Create a new branch from `development` (if you're editing code and not e.g the README) which briefly describes the thing you
are doing, e.g `acpi`.
4. Commit your things
5. Open a pull request. Select base as `development` (again, if you're editing code).
6. Wait for review. Sorry if the reviews are a bit nitpicky -- @gegy1000 and I (@Restioson) usually write reviews like that. It
does help to keep code quality good though.
7. Debate review comments/implement requested changes.
8. Repeat until everyone is happy with the changes.
9. Your PR should be merged Soon™!

## Code Style

Generally, we try to follow [the rust style guidline](https://github.com/rust-lang-nursery/fmt-rfcs/blob/master/guide/guide.md).
To keep the code consistent, we ask if all contributors could also adhere to these guidelines. Unfortunately, we haven't run
Clippy or Rustfmt on flower [just yet](https://github.com/Restioson/flower/issues/13), but this is slated to be done just before
0.2.0. Thus, please refrain from formatting things unrelated to the PR you are working on. This is to avoid merge conflicts.

## Thanks

Expand Down

0 comments on commit a7d25f9

Please sign in to comment.