tilera/nyxx
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Rewritten contributing guidelines

Browse source
This commit is contained in:
Szymon Uglis 2020-06-17 23:40:33 +02:00
parent fefc197428
commit 4517e91254
1 changed files with 21 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
CONTRIBUTING.md
View file

@ -1,3 +1,22 @@
# Contributing
If you want to contribute, feel free to fork and make a PR. Please lint and run `dartfmt` before opening a PR.
And make sure to always make your PRs to `development` branch.
Nyxx is free and open-source project, and all contributions are welcome and highly appreciated.
However, please conform to the following guidelines when possible.
## Development cycle
All changes should be discussed beforehand either in issue or pull request on github
or in a discussion in our Discord channel with library regulars or other contributors.
All issues marked with 'help-needed' badge are free to be picked up by any member of the community.
### Pull Requests
Pull requests should be descriptive about changes that are made.
If adding new functionality or modifying existing, documentation should be added/modified to reflect changes.
## Coding style
We attempt to conform [Effective Dart Coding Style](https://dart.dev/guides/language/effective-dart/style) where possible.
However, code style rules are not enforcement and code should be readable and easy to maintain.
**One exception to rules above is line limit - we use 120 character line limit instead of 80 chars.**