Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (46 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

74 lines (46 loc) · 2.87 KB
Raw

Contributing to This Project

Thank you for your interest in contributing! Your help is greatly appreciated. Before you start, please read and follow these guidelines to ensure a smooth contribution process.

How to Contribute

  1. Feature Requests & Ideas

    • If you have ideas for new features or improvements, please open an issue or start a discussion.
    • Ideas and feature requests are welcome.

  2. Reporting Bugs

    • Please open an issue describing the bug, how to reproduce it, and any relevant details.

  3. Submitting Code

    Before submitting code:

    • Please ensure your code follows the project’s coding standards and passes all tests.

    Steps:

    1. Fork the repository.
    2. Create a new branch for your fix or feature.
    3. Make your changes and write clear, descriptive commit messages.
    4. Ensure all tests pass and add new tests as appropriate.
    5. Sign off your commits (see DCO section below).
    6. Submit a pull request (PR) to the main repository.

  4. Code Review

    • All pull requests are reviewed before merging.
    • Please respond to feedback and make requested changes promptly.

Developer Certificate of Origin (DCO)

All contributions to this repository must comply with the Developer Certificate of Origin (DCO). This is a simple statement that you, the contributor, have the legal right to submit your work under the project's license.

What is the DCO?

The DCO is a declaration you make by adding a Signed-off-by line to your commit messages. This certifies that you wrote the code or otherwise have the right to submit it.

The full text of the DCO is available in the DCO file in this repository, or at developercertificate.org.

How to Sign Off Your Commits

You must add a Signed-off-by line to each commit message. This can be done automatically by using the -s flag with git commit:

git commit -s -m "docs: Your commit message"

This will add something like this to your commit message:

Signed-off-by: Your Name <your.email@example.com>

Pull requests with unsigned commits will not be merged.

How to format the commit messages

All commits MUST use the Conventional Commits specification.

Pull requests with commits not formatted properly will not be merged.

Attribution

All contributors will be listed in CONTRIBUTORS.md. If you have contributed and your name is missing, feel free to open a pull request to add yourself. Do not forget to include or update the AGPL license header at the top of the files you created or modified!

Questions

If you have any questions, feel free to open an issue or contact the maintainer at kapcsolat@kovacsdavid.dev.

Thank you for helping make this project better!