Contributing to Featurer

This document describes how to contribute to Featurer in various ways.

Hello from Russia

First of all, hello from Russia and thanks for stopping by.

Lead developer of this project living in Yekaterinburg, Russia. If you're uncomfortable with it - please do not use Featurer and/or do not try to contribute to it.

Copyright, licenses, DCOs

Code is licensed under terms and conditions of GNU General Public License version 3. By submitting any portion of code via pull requests you accept that your code will be licensed under this license.

By submitting code via Pull Request you should signoff it (via --signoff command line parameter to git). This will mean:

You signing DCO, meaning that code you submitted was really written by you and not copied from other software (especially with incompatible licensing).
You agree to transfer all rights on submitted code to @pztrn.

Non-signed-off pull requests won't be accepted.

Issues

Submitting issues

Before submitting issues please make sure that similar issue isn't created by searching.

Working on issues

Every issue should receive Reviewed/Confirmed badge before it may be worked on.

This badge could place only people that present in maintainers list.

Code

Linting

Please use golangci-lint with configuration from this repository.

Pull requests that failed to pass linters won't be accepted.

Branching

Featurer uses next branching agreement:

main branch is a subject of constant changes.
Fork repository, make changes, create pull request.
Releases are cut from release branches named release/MAJOR.MINOR.

1.7 KiB Raw Blame History