Contributing#

Suggestions#

We keep track of general suggestions on sourcehut, please open a ticket there!

Code / documentation / tests#

ilayoutx is mainly developed on sourcehut, but we accept contributions from GitHub as well.

Open a ticket on SourceHut to request features, report bugs, or express intention to contribute.

After an initial conversation, you will be requested to create a patch and submit it via email. The best way to contribute code from SourceHut is via patches sent to the mailing list. Read the official sourcehut docs for info.

Open an issue on GitHub to request features, report bugs, or express intention to contribute.

The best way to contribute code from GitHub is via Pull Requests (PRs). For new contributors:

git clone https://github.com/YOUR-USERNAME/ilayoutx.git

  • Create a local branch and switch to it (you can choose any branch name you fancy):

git checkout -b <branch name>

  • Make your changes, using commits to document your work.

  • Test your changes by writing and ensuring you pass unit tests via pytest (see below).

  • Push your commits to your forked repository:

git push --set-upstream origin <branch name>

  • From there, make the pull request against the main repository, including a clear title and a detailed description of what your code accomplishes.

Local setup#

Create a local virtual environment:

python -m venv .venv

Update pip (to support dependency groups):

.venv/bin/pip install --upgrade pip

Install maturin:

.venv/bin/pip install maturin

Develop the project in editable mode:

.venv/bin/maturin develop

Install test dependencies:

.venv/bin/pip install --groups test .

Tests#

If you have added code that needs testing, add tests. Ensure the existing test suite passes before submitting your changes.

To test from a local setup, run:

.venv/bin/pytest

and make sure all tests are either passing or skipped. If you’d like to request help with passing tests, write into the issue you previously had open on SourceHut/GitHub.

Pull regularly#

Remember to pull upstream regularly, so your local repo is up to date with the current state of main branch!

git remote add upstream https://github.com/fabilab/ilayoutx

git fetch upstream

Be sure to merge upstream changes locally:

git merge upstream/main