Anish Athalye
2.3 KiB
Contributing to cleanlab
All kinds of contributions to cleanlab are greatly appreciated. If you're not looking to write code, submitting a feature request or bug report is a great way to contribute. If you want to get your hands dirty, you can submit a patch, either working on your own ideas or addressing existing issues.
If you are unsure or confused about anything, please go ahead and submit your issue or pull request anyways! We appreciate all contributions, and we'll do our best to incorporate your feedback or code into cleanlab.
Feature Requests
Do you have an idea for an awesome new feature for cleanab? Let us know by submitting a feature request.
If you are inclined to do so, you're welcome to fork cleanlab, work on implementing the feature yourself, and submit a patch. In this case, it's highly recommended that you first open an issue describing your enhancement to get early feedback on the new feature that you are implementing. This will help avoid wasted efforts and ensure that your work is incorporated into the cleanlab code base.
Bug Reports
Did something go wrong with cleanlab? Sorry about that! Bug reports are greatly appreciated!
When you submit a bug report, please include as much context as you can. This includes information like Python version, cleanlab version, an error message or stack trace, and detailed steps to reproduce the bug. The more information you can include, the better.
Patches
Want to write code to help improve cleanlab? Awesome!
If there are open issues, you're more than welcome to work on those. If you have your own ideas, that's great too! In that case, before working on substantial changes to the code base, it is highly recommended that you first open an issue describing what you intend to work on.
Any changes to the code base should try to follow the style and coding conventions used in the rest of the project.
If you have any questions about contributing to cleanlab, feel free to ask!