We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug 🐛
- Discussing the current state of the code 🔬
- Submitting a fix 🔧
- Proposing new features 🔆
- Submitting a new baseline 📜
- Becoming a maintainer 📈
We Use GitLab Flow, So All Code Changes Happen Through Merge Requests
Merge requests are the best way to propose changes to the codebase (we use GitLab Flow). We actively welcome your merge requests:
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation 📝 .
- Ensure the test suite passes:heavy_check_mark: .
- Make sure your code lints:chart:.
- Issue that merge request!
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
If you see any typos anywhere you can simply raise an issue
The bug report should be in a way so that its easy to comprehend for anyone so they can fix it. Include all information
Great Bug Reports📋 tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- What you expected would happen
- What actually happens:bomb:
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work):memo:
Screenshots are a great way to explain any errors so dont be hesitant.
People love ❤️ thorough bug reports. I'm not even kidding.
As a datascience community we love new insights regarding data and its applications, thus any new submissions regarding notebooks are encouraged. However there are some guidelines that need to followed which are as follows -
- Notebooks should be in .ipynb format or colab format only
- It must have the following section as follows-
- Name of the challenge and Name of the author
- Data Download:memo:
- Importing Packages:clipboard:
- EDA (if required):bar_chart:
- Training Phase(not required if only EDA):chart:
- Testing Phase(not required if only EDA):chart_with_upwards_trend:
- Raise a merge request to add your notebook in the baseline folder of the challenge. 📁
The challenge author will review your notebook and if all goes well, we will feature it soon with our set of notebooks. Also a post with your notebook will be made on discourse form under the discussion tab.
By contributing, you agree that your contributions will be licensed under its MIT License.
This document was adapted from the open-source contribution guidelines for Facebook's Draft