Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.18 KB

Contributing

Thank you for your interest in contributing to qds! We appreciate your help in improving our project.

Getting Started

Please note that this project is dedicated for macOS operating systems. Therefore, contributors will need access to a macOS machine to be able to run and develop the project.

To get started with contributing, you should follow these steps:

  1. Fork the repository to your own GitHub account.

  2. Clone the forked repository to your local machine.

  3. Install the required dependencies

    pip install -r requirements/dev.txt

  4. Create a new branch for your changes.

    git checkout -b your-branch-name

  5. Make your changes to the code.

  6. Write tests to ensure that your changes work as expected.

  7. Create a changelog entry describing your change.

    scriv create

  8. Commit your changes and push them to your forked repository.

  9. Create a pull request (PR) from your forked repository to the main branch of the original repository.

Contact

If you have any questions or need further assistance, please do not hesitate to ask via email or GitHub issues.

We look forward to your contributions!