We are very excited to have you with us!
- Use the
[Title Case Name](link)
format. - All Folders should contain
-
inplace of_
. - All Files should contain
_
inplace of-
- Use concise descriptions.
- Pull requests should have a useful title.
- To add any Project, create a folder in the projects folder with a relevant category.
- Add the Project with detailed explanations in README.md file.
- If there are packages to be installed, create a
requirements.txt
file stating out the packages to be installed or mention in README.md file. - Each folder should contain an
README.md
file.- The file should contain a brief introduction to project.
- Any other resource or blog you think is appropriate or explains the meaning of your folder.
- Please mention It's difficulty level.
- Codes can be contributed using Jupyter Notebooks and
.py
,.r
or.jl
files. But Python and Jupyter Notebooks will be much appreciated because they support a clear explanation of code. - It is very Important that you are uploading project images on your project, please don't use any third party website for hosting Images.
-
Star the repository.
-
On the GitHub page for this repository, click on the Button "Fork".
-
Create clone your forked repository on your local machine.
For example, run this command inside your terminal:
git clone https://github.com/<your-github-username>/python-projects.git
Replace <your-github-username>!
Learn more about forking and cloning a repo.
-
Before you make any changes, keep your fork in sync to avoid merge conflicts:
git remote add upstream https://github.com/gaurtvin/python-projects.git git fetch upstream git pull upstream master git push
-
If you run into a merge conflict, you have to resolve the conflict. There are a lot of guides online, or you can try this one by opensource.com.
-
Checkout to development branch (name your branch according to the issue name).
git checkout -b <branch-name>
-
Create a folder in projects directory according to issue name.
-
Write your code and add to the respective folder in the projects directory, locally.
-
Don't forget to add a
README.md
in your folder by follwing README.md Template. -
Add the changes with
git add
,git commit
(write a good commit message, if possible):git add -A git commit -m "<your message>"
-
Push the code to your repository.
git push origin <branch-name>
-
Go to the GitHub page of your fork, and make a pull request:
Read more about pull requests on the GitHub help pages.
-
Now wait, until one of us reviews your Pull Request! If there are any conflicts, you will get a notification.
- Any contribution is welcomed such as fixing grammatical errors, fixing broken links, fixing bugs, etc.
- Before contributing, here's our Code of Conduct which must be adhered to.
- Verify that any project(s) to be added isn't already present in the repository, as yours may be a duplicate.