Skip to content

Latest commit

 

History

History
34 lines (18 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

34 lines (18 loc) · 2.24 KB
Raw

Contributing

Firstly, thank you for your interest in contributing to our project! Open-source projects are the strength of the tech community, and it's contributors like you that help make these projects a success. Here are a few guidelines to help you along the way.

How Can I Contribute?

There are several ways you can contribute to this project:

  1. Bug Reports: If you find a bug in the codebase, feel free to open an issue on our repository. Be sure to include all the necessary details like what the issue is, steps to reproduce the issue, and any possible solutions you can think of.

  2. Feature Requests: If you have an idea for a new feature or an enhancement to an existing one, we'd love to hear about it! Open an issue describing your idea, why you think it would be beneficial to the project, and any potential approaches to implementing it.

  3. Code Contributions: If you're up for some coding, you can browse through the open issues, and start working on one that interests you. If you plan to make a significant contribution, it's best to create an issue first explaining the changes you want to make to get feedback from the maintainers.

Pull Request Process

  1. Fork the project, create a branch from main, make your changes, and then push them to your branch.

  2. Submit a pull request to the main branch of the original repository.

  3. In your pull request description, explain the changes you made, why you made them, and any potential side effects or impacts of these changes. If your PR resolves a specific issue, be sure to link to it in the description.

  4. Make sure your code adheres to the existing style of the project to make it easier for the maintainers to merge your PR.

  5. Your PR will be reviewed by the maintainers, who may request some changes. Please be patient during this process and make any necessary changes.

  6. Once your PR is approved, it will be merged into the main branch.

Contact

If you have any questions or need further clarification on anything, feel free to reach out to the main author of this project, Robin Röper at rroeper@superclustr.net.

Remember, the goal is to create a positive environment where everyone can feel comfortable contributing. Happy coding!