Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 2.16 KB
Raw

Contributing

Thank you for your interest in contributing to this project! I welcome contributions of all kinds, including bug fixes, new features, and documentation improvements. Before you start, please take a moment to read through this guide.

Discuss Your Idea

Before making any changes, please discuss the change you wish to make. This can be done via a pull request, issue, email, or any other method.

This helps ensure that your contribution aligns with the project's goals and that we can provide guidance and feedback early in the process.

Pull Request Process

When you're ready to submit your changes, follow these steps to create a pull request:

  1. Prepare Your Changes:

    • Ensure your code follows the project's coding standards and conventions (lol).
    • Test your changes thoroughly to make sure they work as expected.

  2. Create a Pull Request:

    • Go to the repository on GitHub and navigate to the "Pull Requests" tab.
    • Click the "New pull request" button.
    • Choose the branch that contains your changes and the dev branch to merge into.

  3. Describe Your Changes:

    • In the pull request description, provide a bullet point list of your changes.
    • Clearly explain what your changes do and what problem you are solving.
    • If your changes relate to an existing issue, please reference the issue number (e.g., Closes #123).

  4. Submit Your Pull Request:

    • Click the "Create pull request" button to submit your changes for review.

Review and Feedback

  1. Review Process:

    • Once your pull request is submitted, it will be reviewed for any conflicts with ongoing work and provide feedback or request changes if necessary.

  2. Address Feedback:

    • Make any requested changes and update your pull request as needed.
    • Communicate with the reviewers if you have any questions or need clarification.

  3. Merge and Release:

    • After your changes are approved, they will be merged into the dev branch.
    • Please note that all releases, pull requests to main will be managed and pushed by the repository owner.

Thank you for your contributions! Your efforts help make this project better for everyone.