Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

54 lines (32 loc) · 1.98 KB
Raw

Contributing to ReciMaster

We're thrilled that you're interested in contributing to ReciMaster! This document outlines how you can get involved and help make ReciMaster even better.

Ways to Contribute

There are several ways you can contribute to ReciMaster:

  1. Combat Critical Issues: Help us identify and fix bugs, security vulnerabilities, or performance issues.
  2. Add New Features: Propose and implement new features that would enhance the user experience.
  3. Improve Existing Features: Refine and optimize current functionalities.
  4. Open-ended Contributions: Have an idea that doesn't fit the above categories? We're open to creative contributions!

How to Contribute

  1. Fork the Repository: Start by forking the ReciMaster repository to your GitHub account.

  2. Clone the Forked Repository: Clone your fork to your local machine.

  3. Create a New Branch: Make a new branch for your contribution.

  4. Make Your Changes: Implement your bug fix, feature, or improvement.

  5. Test Your Changes: Ensure your changes don't break existing functionality.

  6. Commit Your Changes: Make clear, concise commit messages.

  7. Push to Your Fork: Push your changes to your GitHub fork.

  8. Open a Pull Request (PR): Submit a PR from your fork to the main ReciMaster repository.

Pull Request Guidelines

When submitting a pull request:

  • Provide a clear title and description of your changes.
  • Reference any related issues.
  • Ensure your code follows the project's coding standards.
  • Include tests if applicable.
  • Update documentation if necessary.

Code Review Process

Once you've submitted a PR:

  1. The maintainers will review your code.
  2. They may request changes or ask questions.
  3. Once approved, your contribution will be merged.

Questions?

If you have any questions or need further clarification, don't hesitate to open an issue for discussion.

Thank you for contributing to ReciMaster! Your efforts help make this project better for everyone.