This documentation contains a set of guidelines to help you during the contribution process.
We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project.
Thank you for helping out and remember, no contribution is too small.
Please note we have a code of conduct please follow it in all your interactions with the project.
You can refer to the following articles on the basics of Git and GitHub and also contact the Project Mentors, in case you are stuck:
- Forking a Repo
- Cloning a Repo
- How to create a Pull Request
- Getting started with Git and GitHub
- Learn GitHub from Scratch
- Go to the project's issues.
- Select the template that better fits your issue.
- Give a proper description of the issues.
- Don't spam to get the assignment of the issue 😀.
- Wait for till someone is looking into it!
- Start working on the issue only after you get assigned that issue 🚀.
- There are main three folders
data,scripts,notebooks - You get the datafiles with the issue so just add the data set under the folder
data->dataset-<#issue number>->file.csvor any other types of data there can be multiple data files also data->dataset-<#issue number>also make oneREADME.mdin which explain about the dataset- next
- if you want any preprocessing or any kind of scripts then add a folder in the folder
scripts/name itissue-<#issue-number>and add all the scripts that you created - if possible add the README.md file in the folder
scripts/issue-<#issue-number>which you created in the upper step and explain what your script is doing - after
- make a folder in the
notebooks/name itissue-<#issue-number>and add your data analysis or task you have into it and if possible add accuracy about the issue solved - Submit your PR by giving the necessary information in the PR template and hang tight we will review it really soon 🚀