43 lines
3.3 KiB
Markdown
43 lines
3.3 KiB
Markdown
|
<img src="https://raw.githubusercontent.com/JustEnoughLinuxOS/distribution/dev/distributions/JELOS/logos/jelos-logo.png" width=192> [](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [](https://github.com/JustEnoughLinuxOS/distribution/commits) [](https://github.com/JustEnoughLinuxOS/distribution/pulls) [](https://discord.gg/seTxckZjJy)
|
||
|
|
#
|
||
|
|
|
||
|
|
# Contributing to JELOS
|
||
|
|
Welcome new contributor! Your contribution will help JELOS become a better Linux distribution, so thank you! We want to make contributing to this project as easy and transparent as possible. Contributors are able to:
|
||
|
|
|
||
|
|
- Discuss the current state of the code
|
||
|
|
- Submit a fix
|
||
|
|
- Propose new features
|
||
|
|
- Become a maintainer
|
||
|
|
|
||
|
|
## Becoming a maintainer
|
||
|
|
When contributing to JELOS you are expected to become the maintainer of your contribution. Please keep this in mind when submitting pull requests.
|
||
|
|
* Keep track of your contributions upstreams and keep your components up-to-date.
|
||
|
|
* Watch the issue tracker and resolve issues related to your contribution.
|
||
|
|
|
||
|
|
## We Develop with Github
|
||
|
|
We use Github to host code, to track issues and feature requests, as well as accept pull requests.
|
||
|
|
|
||
|
|
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
|
||
|
|
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
|
||
|
|
|
||
|
|
1. Join our discord and chat with us, we'll be happy to help you successfully implement your change.
|
||
|
|
2. Fork the repo and create your branch from `dev`.
|
||
|
|
3. Ensure your code is built locally and tested.
|
||
|
|
4. Any changes should be reflected in the documentation.
|
||
|
|
5. Issue a pull request back to our `dev` branch.
|
||
|
|
|
||
|
|
## Any contributions you make will be under the Apache 2 Software License
|
||
|
|
In short, when you submit code changes, your submissions are understood to be contributed under the same license as the original project code or under [Apache 2](https://choosealicense.com/licenses/apache-2.0/) license when no other license applies.
|
||
|
|
|
||
|
|
## Use a Consistent Coding Style
|
||
|
|
* Follow the same style as the source you are editing.
|
||
|
|
* If you are contributing new code, keep the style consistent with other similar works.
|
||
|
|
* Parameterize as much as possible, try to avoid hard coded values whenever you can.
|
||
|
|
* Use 2 spaces for indentation rather than tabs when possible.
|
||
|
|
|
||
|
|
## License
|
||
|
|
By contributing, you agree that your contributions will be licensed under the license of the existing project code being modified or Apache 2.
|
||
|
|
|
||
|
|
## References
|
||
|
|
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
|