Contributing to UNIQUE

Contributing to UNIQUE#

Thank you for considering contributing to UNIQUE! 🎉

How Can You Contribute?#

Reporting Bugs 🐛#

Found a bug? We appreciate you taking the time to let us know! Please follow these steps to report it:

  1. Ensure the bug hasn’t been reported already by checking existing issues.

  2. If it’s a new issue, open a new one. Be sure to include a clear title and description, along with any relevant information to help us reproduce the bug (e.g., OS, conda/virtual environment, minimal reproducible example, etc.).

Please, include [Bug] in the issue title to make it easier to track and spot the issue.

Requesting Features 🚀#

Have an idea for a new feature or improvement? Share it with us! Here’s how:

  1. Check existing issues to see if your feature request has been suggested before.

  2. If it’s a new idea, open a new issue. Describe the feature you’d like to see, along with any relevant details and a use case in which the feature would be used.

Please, include [Feature Request] in the issue title to make it easier to track and spot the issue.

Contributing Code 💻#

Interested in contributing code? Awesome! Follow these steps to get started:

  1. Feel free to submit an issue first before working on the feature to see whether your contribution and idea is something the maintainers and other users would find useful.

  2. Fork the repository and create your branch from master.

  3. Implement your changes, making sure to document and test your code, by including docstrings (following Google-style docstrings), type-hinting, thorough unit-testing, etc.

  4. Submit a pull request to the master branch. Provide a clear title and description of your changes, along with any relevant information or context (e.g., OS, environment and dependencies, etc.). If your PR fixes a bug, detail what the problem was (linking to existing bug issues, if any) and how it was fixed. If your PR adds new code, include justification for why this code is relevant and should be added (linking to existing feature requests, if any).

  5. Ensure that maintainers are allowed to edit your PR, by following these instructions.

The maintainers and/or other power-users will discuss the PR and eventually merge it into the main branch if accepted.

[!TIP] Use tools such as black and isort to make your code PEP-8 compliant and avoid any merging issues.

Code of Conduct 🤝#

Please note that we have a Code of Conduct in place to ensure a positive and inclusive community environment. By participating in this project, you agree to abide by its terms.

Thank You! 🙌#

We appreciate your contributions to UNIQUE! Your help makes this project better for everyone. Let’s build something amazing together! 🚀

On this page