Skip to content

Latest commit

 

History

History
95 lines (59 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

95 lines (59 loc) · 2.5 KB
Raw

Contribution Guidelines

Contributions Welcome

Never made an open source contribution before? Wondering how contributions work in our project? Here's a quick rundown!

Take a look at the Existing Issues or create your own Issues!

  • Wait for the Issue to be assigned to you after which you can start working on it.
  • Fork the Repo and create a Branch for any Issue that you are working upon.
  • Read the Code of Conduct
  • Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.

Fork this repository

  • Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

Clone the repository

  • Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project).

For example:

git clone https://github.com/user-name/Joker.py.git

where user-name is your GitHub username. Here you're copying the contents of the Joker.py repository on GitHub to your computer.

Navigate to the project directory

  • After cloning the project in your computer, navigate to the project file using the command below.
cd Joker.py

Create a new branch

git checkout -b <your_branch_name>
  • Perform your desired changes to the code base.
  1. Check you changes.
git status

git diff
  1. Stage your changes
git add . <\files_that_you_made_changes>
  1. Commit your changes.
git commit -m "Relevant message"
  1. Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>

  1. To create a pull request, click on `compare and pull request.

  2. Add an appropriate title and description to your PR explaining your changes.

  3. Cick on Create pull request.

That's it we setup the project into our local machine.

  • Congrats!!! You have made a PR to the Joker.py. Wait for your submission to be accepted and your PR to be merged.

  • Wait for the pull request to be reviewed by a maintainer. Make changes to the pull request if the reviewing maintainer recommends them.

  • Celebrate 🥳 your success after your first pull request is merged!