Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 4.91 KB

CONTRIBUTING.md

File metadata and controls

84 lines (60 loc) · 4.91 KB
Raw

Contributing to archinstall

Any contributions through pull requests are welcome as this project aims to be a community based project to ease some Arch Linux installation steps. Bear in mind that in the future this repo might be transferred to the official GitLab repo under Arch Linux (if GitLab becomes open to the general public).

Therefore, guidelines and style changes to the code might come into effect as well as guidelines surrounding bug reporting and discussions.

Branches

master is currently the default branch, and that's where all future feature work is being done, this means that master is a living entity and will most likely never be in a fully stable state. For stable releases, please see the tagged commits.

Patch releases will be done against their own branches, branched from stable tagged releases and will be named according to the version it will become on release. (Patches to v2.1.4 will be done on branch v2.1.5 for instance).

Discussions

Currently, questions, bugs and suggestions should be reported through GitHub issue tracker.
For less formal discussions there is also an archinstall Discord server.

Coding convention

ArchInstall's goal is to follow PEP8 as best as it can with some minor exceptions.

The exceptions to PEP8 are:

  • Archinstall uses tabs instead of spaces simply to make it easier for non-IDE developers to navigate the code (Tab display-width should be equal to 4 spaces). Exception to the rule are comments that need fine-tuned indentation for documentation purposes.
  • Line length a maximum line length is enforced via flake8 with 220 characters
  • Line breaks before/after binary operator is not enforced, as long as the style of line breaks is consistent within the same code block.
  • Archinstall should always be saved with Unix-formatted line endings and no other platform-specific formats.
  • String quotes follow PEP8, the exception being when creating formatted strings, double-quoted strings are preferred but not required on the outer edges ( Example: f"Welcome {name}" rather than f'Welcome {name}').

Most of these style guidelines have been put into place after the fact (in an attempt to clean up the code).
There might therefore be older code which does not follow the coding convention and the code is subject to change.

Git hooks

archinstall ships pre-commit hooks that make it easier to run checks such as mypy, ruff check, and flake8 locally. The checks are listed in .pre-commit-config.yaml and can be installed via

pre-commit install

This will install the pre-commit hook and run it every time a git commit is executed.

Documentation

If you'd like to contribute to the documentation, refer to this guide on how to build the documentation locally.

Submitting Changes

Archinstall uses GitHub's pull-request workflow and all contributions in terms of code should be done through pull requests.

Anyone interested in archinstall may review your code. One of the core developers will merge your pull request when they think it is ready. For every pull request, we aim to promptly either merge it or say why it is not yet ready; if you go a few days without a reply, please feel free to ping the thread by adding a new comment.

To get your pull request merged sooner, you should explain why you are making the change. For example, you can point to a code sample that is outdated in terms of Arch Linux command lines. It is also helpful to add links to online documentation or to the implementation of the code you are changing.

Also, do not squash your commits after you have submitted a pull request, as this erases context during review. We will squash commits when the pull request is merged.

Maintainer:

At present the current contributors are (alphabetically):