Contributing

Welcome! We are excited that you are interested in contributing to our project! It's people like you that make this project great.

Here's what you need to know:

Ways to Contribute

As a new contributor, you're in an excellent position to provide valuable feedback. Here are some ways you can help:

• Fix or report a bug.
• Suggest enhancements to code, tests, and documentation.
• Report or fix problems found during installation or in developer environments.
• Propose new features or improvements.

Community Guidelines

Be nice and respectful to each other.

We follow the Contributor Covenant Code of Conduct.

File an Issue

Before creating a new issue, please check if a similar one already exists.

If so, you can add your information as a comment to the existing issue.

Report a Bug

Reporting bugs is a valuable way to contribute:

1. Open an issue that summarizes the bug.
2. Set the label to "bug".

Suggest a Feature

To request a new feature:

1. Open an issue summarizing the desired functionality and its use case.
2. Set the label to "feature" or "enhancement".

Contribute Code, Documentation, and More

To contribute code, documentation, or other improvements, please follow these steps:

1. Discuss your plans beforehand to ensure alignment with project goals.
2. Check the list of open issues. Assign yourself an existing issue or create a new one.
3. Follow project conventions for tests, code style, documentation, and commit messages.
4. Understand that contributions may be declined if they don't align with project guidelines or goals.
5. Familiarize yourself with the Pull Request Lifecycle.
6. Agree to the "inbound=outbound" norm: your contributions will be under the same license as the project.
7. Sign your commits.

Issues and Pull Request Feedback

Project maintainers will do their best to review and respond to issues within [INSERT_DAYS] business days.

The quality of information in your issue or pull request will affect the feedback loop.

For non-trivial contributions, please discuss with the project team first.

If the project is not listed as archived, it is maintained.

Pull Request Lifecycle

We use the Fork-and-Pull Model:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature-name).
3. Make your changes.
4. Commit your changes (git commit -s -m 'feat: Add some feature').
5. Push to the branch (git push origin feature/your-feature-name).
6. Open a pull request.

Commit Guidelines

DCO - Signoff and Signing a Commit

Signoff (DCO agree)

A Signoff assures to the project that you have the right to contribute your content +

Add a signoff to your commit using the -s or --signoff flag:

git commit --signoff -m 'fix: add fix for superbug x'

Sign

A Sign assures that the commit came from you

Sign your commit with -S or --gpg-sign:

git commit --signoff --gpg-sign -m "fix: add fix for the bug"

Commit Standard

• Follow the Conventional Commit standard, including starting the commit message with an imperative verb (e.g., "feat:", "fix:", "chore:").

Reporting Security Issues

For security vulnerabilities, please follow the guidelines in our Security information.

Writing Style and Translations

• Keep documentation easy to read.
• Use bullet points for clarity.
• Be concise and link to external resources when needed.
• Use British English (e.g., "colour" instead of "color").
• Follow the one-sentence-per-line principle in Markdown or AsciiDoc.

English is the primary language, with translations on a best-effort basis.

Happy contributing!