Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 2.36 KB
Raw

Contributing to pyspry

Thank you for your interest in contributing to pyspry! We appreciate your help to make this project better.

Table of Contents

Code of Conduct

Please note that by participating in this project, you are expected to adhere to the Community Code of Conduct. Treat each other with respect to create a positive and inclusive environment. 🥳

How Can I Contribute?

There are several ways you can contribute to pyspry!

Reporting Bugs 🪲

If you encounter any bugs while using pyspry, please open a new issue using the bug.md template.

Suggesting Features / Enhancements ✨

If you have any ideas or suggestions to improve pyspry, please open a new issue using the feature.md template.

Merge Requests

Merge requests for bug fixes, enhancements, and new features are very welcome. To contribute code to pyspry, follow these steps:

  1. Create a fork of the repository
  2. Implement your changes in the fork, ensuring they adhere to the project's linters and formatters
  3. Open a new merge request from your fork to the pyspry repository, and provide a detailed description of your changes.

Note: each contribution must pass all CI/CD and linting tests in order to be considered.

Once your pull request is submitted, it will be reviewed by the project maintainers. Please be patient, as it may take some time to receive feedback.

Development Setup

Refer to the README for details on how to set up a development environment for pyspry.

License

By contributing to pyspry, you agree that your contributions will be licensed under the project's OSI approved license.