Skip to content

Latest commit

 

History

History
111 lines (70 loc) · 3.73 KB

CONTRIBUTING.md

File metadata and controls

111 lines (70 loc) · 3.73 KB

Contributing Guidelines 🌟

✅ Issues will be assigned on a first come first serve basis.
✅ Max 2 issues can be assigned to a single individual.
✅ Mention the language you want to work in while asking for issues.
✅ Make a separate branch for each issue, use appropriate branch names for the same.
✅ Write clean and easy to understand code.
✅ Provide comments wherever necessary.
✅ Add a README.md to the folder explaining the working of the script.
✅ Add an appropriate screenshot of output or demo in the README.
✅ Add a "requirements.txt" file if dependencies are required.
✅ Perform a self-review before submitting the PR and wait for the mentors to review it for merge

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). See the previous steps to obtain the url.

For example:

git clone https://github.com/sanscript-tech/hacking-tools-scripts

Create a branch ⚓

Change to the repository directory on your computer (if you are not already there):

cd (filename)

Now create a branch using the git checkout command:

git checkout -b your-new-branch-name

For example:

git checkout -b dev_username

Make necessary changes and commit those changes 🚏

Do the necessary changes.

If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

git add .

Now commit those changes using the git commit command:

git commit -m "(Add your message here)"

replacing <Add your message here> with your message.

Push changes to GitHub 🪂

Push your changes using the command git push:

git push origin <branch-name>

replacing <branch-name> with the name of the branch you created earlier.

Submit your changes for review 🚩

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

Now submit the pull request.