2. Contribute with Git

Before creating your first pull request, set up your fork to contribute to PyRIT by following these steps:

Step 1: Fork

Fork the repo from the main branch. By default, forks are named the same as their upstream repository. This will create a new repo called GITHUB_USERNAME/PyRIT (where GITHUB_USERNAME is a variable for your GitHub username).

Step 2: Add remote and make changes

Add this new repo locally wherever you cloned PyRIT

# to see existing remotes
git remote -v

# add your fork as a remote named `REMOTE_NAME`
git remote add REMOTE_NAME https://github.com/GITHUB_USERNAME/PyRIT.git

To add your contribution to the repo, the flow typically looks as follows:

git checkout main
git pull # pull from origin
git checkout -b mybranch

... # make changes

git add .
git commit -m "changes were made"
git push REMOTE_NAME

Step 3: Create PR

After pushing changes, you’ll see a link to create a PR:

remote: Create a pull request for 'mybranch' on GitHub by visiting:
remote:      https://github.com/GITHUB_USERNAME/PyRIT/pull/new/mybranch

See more on creating a pull request from a fork.

Step 4: PR review

After you create a pull request, a member of the core team will review it. A PR needs to be approved by a member of the core team before it’s merged.

If a PR has been sitting for over a month waiting on the author, then the core team may opt to close it (but you are always free to re-open).