Guidelines for Contributing to BeanConqueror

[graphefruit]

Hello, BeanConquerors!

First and foremost, thank you for your interest in contributing to the Beanconqueror product! We truly appreciate the time and effort you put into making BeanConqueror better.

To ensure that all contributions align with the vision and goals of the product, we kindly ask that you follow these guidelines before submitting a pull request (PR):

1. Discuss Your Idea First: Before starting on any new feature or major change, please create an issue or reach out to me via email to discuss your idea. This helps ensure that your contribution fits well with the product's overall concept and avoids any potential conflicts with ongoing work.

2. Alignment with Product Goals: Make sure your contribution aligns with the core goals and philosophy of BeanConqueror. We're looking for improvements that enhance the user experience without deviating from the intended purpose of the app.

3. Clear and Descriptive Issues: When creating an issue to discuss your idea, please provide a clear and detailed description of what you want to achieve. This includes the problem you're trying to solve, your proposed solution, and any relevant mockups or examples.

4. Collaborate and Communicate: We value collaboration and open communication. Feel free to engage in discussions on issues and pull requests, provide feedback, and ask questions. This helps create a better understanding and fosters a community spirit.

5. Quality Standards: Ensure that your code meets the product quality standards. This includes writing clean, well-documented code, following the product's coding conventions, and testing your changes thoroughly before submitting a PR.

6. Documentation: If your contribution involves significant changes or new features, please update the documentation accordingly. This helps other users and contributors understand your work and its impact on the product.

7. Please use the develop-branch as a merge target, after master is regulary out of date

By following these guidelines, you’ll help us maintain a high-quality, cohesive product that benefits everyone. Your contributions are invaluable, and we want to work together to make BeanConqueror the best it can be.

Thank you for your understanding and cooperation. If you have any questions, don't hesitate to reach out.

Happy coding!

Have a great cup of coffee
Lars