wbrawner/jelos.org
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
jelos.org/docs/contribute/index.md
anthonycaccese 44b98fd19d Update index.md
2023-10-25 18:40:26 -04:00

2.3 KiB
Raw Permalink Blame History

Contributing to JELOS

Your contribution helps JELOS become a better Linux distribution, so we're glad you're here! We aim 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 upstream 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.

Pull requests are the best way to propose changes to the codebase (we use Github Flow). 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.

Use a Consistent Coding Style

  • Please 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

When you submit code changes, your submissions are understood to be contributed under the same license as the original project code or under GPLv2 license when no other license applies.

Getting Started

Our recommended next step is getting a build environment set up so you can see how JELOS works and how packages are built. Check out the details in Building JELOS and if you have any questions please let us know on Discord.

!!! note "This document was adapted from the open-source contribution guidelines for Facebook's Draft"