forked from cleanlab/cleanlab
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1053107
commit 3fb5024
Showing
1 changed file
with
53 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,55 @@ | ||
Contributions to cleanlab are welcome. When contributing, please keep the following in mind: | ||
# Contributing to cleanlab | ||
|
||
1. Avoid adding blank lines or spaces to the ends of lines. | ||
2. Follow PEP-8 coding style. | ||
3. Always add tests to check the code you added. Tests go in `cleanlab/tests/`. | ||
4. Submit a pull request (it will automatically run your code and make sure nothing breaks). | ||
All kinds of contributions to cleanlab are greatly appreciated. If you're not | ||
looking to write code, submitting a [feature request](#feature-requests) or | ||
[bug report](#bug-reports) is a great way to contribute. If you want to get | ||
your hands dirty, you can submit a [patch](#patches), either working on your | ||
own ideas or addressing [existing issues][issues]. | ||
|
||
Thanks! | ||
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][issue]. | ||
|
||
If you are inclined to do so, you're welcome to [fork][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][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][issue], 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][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][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][discussions]! | ||
|
||
[issue]: https://github.com/cleanlab/cleanlab/issues/new | ||
[issues]: https://github.com/cleanlab/cleanlab/issues | ||
[fork]: https://github.com/cleanlab/cleanlab/fork | ||
[discussions]: https://github.com/cleanlab/cleanlab/discussions |