-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update README and CONTRIBUTING
- Loading branch information
1 parent
c2cde3b
commit b8d80d9
Showing
2 changed files
with
70 additions
and
28 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 |
---|---|---|
@@ -1,6 +1,40 @@ | ||
# Contributing to flow | ||
|
||
Thank you for stopping by here! There are many ways to make Flow better for | ||
everyone. Here are few: | ||
|
||
* [Reporting a bug](https://github.com/flow-mn/flow/issues/new/choose) | ||
* [Proposing a feature](https://github.com/flow-mn/flow/issues/new?assignees=&labels=&projects=&template=feature_request.yaml&title=%5BFEAT%5D+) | ||
* Submitting [fixes, feature implementations](#developing) | ||
* [Translating Flow](#translating) to your own language | ||
* [Tipping the maintainer](https://ko-fi.com/sadespresso). Flow is a | ||
free and open-source software, and will stay this way. Please understand | ||
that by giving tip, you will NOT unlock any new or additional features. | ||
As of now, publishing fees have been paid by the maintainer. | ||
|
||
## Developing | ||
|
||
1. Fork the repository | ||
2. Pick an issue | ||
3. Make a feature branch | ||
4. Submit a PR to `main` branch | ||
2. Pick an issue. If the fix/feature you're gonna work doesn't have an issue, | ||
please create one first. | ||
3. Let everyone know that you're working on it by commenting "I'm working on it" | ||
4. Create a feature branch. For example, if you're working on [#82](https://github.com/flow-mn/flow/issues/82), | ||
create a branch `fix82` from `main` | ||
5. Make changes on the new branch | ||
6. Ensure your code doesn't have any linter warnings, errors | ||
(Your editor will tell you, or you can run `flutter analyze`) | ||
7. Submit a PR to `main` branch | ||
|
||
## Translating | ||
|
||
When translating Flow to your language, the translation coverage must be 100%. | ||
You can follow the same steps in [Developing](#developing), and you can safely | ||
skip lints and tests (step 6 and 7). | ||
|
||
It's highly recommended to copy [en_US.json](./assets/l10n/en_US.json) or | ||
any other existing translations on work on top of it. | ||
|
||
## License | ||
|
||
By contributing, you agree that your contributions will be licensed under | ||
GNU GENERAL PUBLIC LICENSE v3 |
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