Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

93 lines (60 loc) · 2.88 KB
Raw

Rucio Documentation contributing guide

Thank you for investing your time in contributing to our project!

In this guide you will get an overview of the contribution workflow from creating a PR, reviewing, and merging the PR related to the rucio documentation. If you want to contribute to the rucio project, check out https://www.github.com/rucio/rucio.

Getting started

To get an overview of the project, read the README.

Project Structure

There are 2 branches in this repository:

Open an issue

If you find a bug or have an idea for a change, open an issue. The issue should describe the change, as well as the intention of the change. Afterwards, the issue gets reviewed by our team.

Make Changes

Everyone is welcome to make changes!

The following represents the process of submitting changes to the repository:

Upload changes

  1. Fork the repository.

  2. Clone the fork.

  3. Create a working branch and start with your changes.

  4. Commit the changes and push the branch to the fork. A commit should represent a coherent unit of change. There can be more than one commit per PR. Avoid commits with simple messages like change or fix.

  5. Create a PR in the main repository from the branch. This will trigger the GitHub actions and run basic checks against the repository. Fix all changes till the Actions do not fail.

  6. Follow the discussions on the PR and contribute with your own ideas, every idea is welcome! If there are changes required, go back to step 4.

Git Hooks

The pre-commit python package is configured for this repository. The pre-commit hook checks the syntax and format of the files before committing. This saves time in the development process, since minor errors are noticed early.

To install the package and activate the hooks for the project run:

pip install pre-commit
pre-commit install

Static Code Checkers

This repository uses static code checkers to check the style, integrity and used anti-patterns in the scripts.

Shellcheck

shellcheck is used to check the shell scripts for common anti-patterns.

Black

black is used to format the python scripts. The program automatically re-formats python files to follow their rules.

Isort

isort is used to sort the python imports. Thes imports are also grouped together by different categories, which makes it easier to read the source code.

Flake8

flake8 checks the python code for common anti-patterns. The anti-patterns include "unused imports", "unused code", "overfull line", ... .