40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
|
# Contributing to Ultrawidify
|
||
|
|
|
||
|
|
Thank you for considering contributing to this project! We welcome contributions from the community and are grateful for your efforts.
|
||
|
|
|
||
|
|
## How to Contribute
|
||
|
|
|
||
|
|
0. Open an issue, where you introduce the feature you want to add or thing you want to fix
|
||
|
|
1. Fork the repository.
|
||
|
|
2. Create a new branch for your contribution.
|
||
|
|
3. Write readable code
|
||
|
|
4. Check that your additions do not break existing features
|
||
|
|
5. Open a pull request
|
||
|
|
|
||
|
|
## Code of Conduct
|
||
|
|
|
||
|
|
Please follow the code of conduct:
|
||
|
|
|
||
|
|
* don't be too much of an asshole
|
||
|
|
* language policing my code comments is not a worthwhile contribution, and is considered spam. If you're here to do that, fuck off. I'm looking at you, ScamOSS and co.
|
||
|
|
|
||
|
|
## Code Style
|
||
|
|
|
||
|
|
- Use formatting consistent with the rest of the project
|
||
|
|
- Write meaningful commit messages.
|
||
|
|
- Include comments where necessary to explain complex logic.
|
||
|
|
|
||
|
|
## Licensing & Contribution Agreement
|
||
|
|
|
||
|
|
By submitting a contribution (e.g., via pull request), you agree to the following:
|
||
|
|
|
||
|
|
- You grant the project maintainer(s) a non-exclusive, irrevocable, worldwide, royalty-free license to use, copy, modify, and distribute your contributions as part of the project.
|
||
|
|
- You certify that your contributions are your original work and that you have the right to submit them.
|
||
|
|
- You agree that your contributions are licensed under the same license as the rest of the project, unless explicitly stated otherwise.
|
||
|
|
|
||
|
|
**TL;DR:** once your code is in the project, there's no take-backsies.
|
||
|
|
|
||
|
|
## Questions?
|
||
|
|
|
||
|
|
The discussion board is right over there, three tabs to the right.
|