lix-project/lix
17
37
Fork 14
Code Issues 286 Code Review (Gerrit) Projects 1 Releases Wiki Activity
lix/CONTRIBUTING.md
raito 36d69864f3 chore: re-work the contribution guide 
As per our bootstrap governance discussions, here's a very simple
proposal which links as much as possible to our wiki.

Change-Id: I88b1c43f933ff7e529151b1e933fad40283383c4
Signed-off-by: Raito Bezarius <raito@lix.systems>
2024-05-07 01:28:35 +00:00

2.6 KiB
Raw Permalink Blame History

Contributing to Lix

Welcome and thank you for considering contributing to Lix! We're currently in a soft release phase, and your support means a lot to us.

To ensure a smooth and effective contribution process, here is a summary of our guidelines:

Getting help?

If you have any question regarding getting started or reporting bugs, feel free to reach out to us.

On Matrix, we have a space at #space:lix.systems, composed of:

Report a bug

  • Check if your bug has already been reported in the issue tracker.
  • If you can't find the bug or feature, please open a new issue.

We maintain a copy of the upstream Nix bugs. Their organisation can be read about here.

Report a security vulnerability

For security vulnerabilities, reach out by email at security at lix dot systems.

Making changes to Lix

Before diving into making changes, we want to engage with you and your ideas.

We have a few policies in effect; please take the time to familiarize yourself:

To avoid duplication of effort, it may be a good idea to check out the list of pending pull requests (or "change lists", as Gerrit calls them). Once you have an idea of what you might want to do, we recommend dropping a message on our Matrix to ensure your contribution fits with our current schedule and plans

When you're ready and your changes are ready to go:

  • Submit your code.

    • Submitting a GitHub PR on our mirror is totally ok if that's easier for you and your change is relatively small (300 lines or so).

      We may ask you to resubmit it as a Gerrit CL if it is necessary for the change you're making.

    • Our primary code review system is our Gerrit instance, where you can open a change list (CL). If you're new to Gerrit, check out our wiki page about Gerrit.

  • Make sure to link any related issues.
  • If needed, indicate that the change is 'work in progress'.

You can obtain an account on our platforms by clicking "Sign In with GitHub" on the sign-in page.