Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
prabhuomkar committed Nov 23, 2019
1 parent f4e1610 commit d91955c
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,29 @@

## Before you start


* Comment on the issue that you plan to work on so we can assign it to you and there isn't unnecessary duplication of work.
* When you plan to work on something larger (for example, adding new features to Dataset Class), please respond on the issue (or create one if there isn't one) to explain your plan and give others a chance to discuss.
* If you're fixing some smaller issue - please check the list of pending Pull Requests to avoid unnecessary duplication.

## How can you help


You can help in multiple ways:
* Reproducing bugs, finding its root cause and providing fixes to that, this will be appreciated a lot (see the issues with label: `bug`)
* Sending Pull Requests for new kaggle datasets and/or requested features (see the issues with label: `dataset request` or `enhancement`)
* Doing Code Reviews on the Pull Requests from the developers of this community and verifying if PRs are working correctly or not

## Datasets


Adding a Kaggle Dataset is a great way of making it more accessible to the various communities. [Add a new Kaggle Dataset]() guide will be available soon.

## Tests

We use [pylint](https://www.pylint.org/) for ensuring kaggledatasets is nice and easy to use and work on long-term, all modules should have clear tests for public members.

## Pull Requests

## PRs


All contributions are done through Pull Requests here on GitHub.

## Code Reviews


All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) for more information on using pull requests.

0 comments on commit d91955c

Please sign in to comment.