This document covers how to contribute to the Apache Shiro project. These instructions assume you have a GitHub.com account, so if you don't have one you will have to create one. Your proposed code changes will be published to your own fork of the Apache Shiro project and you will submit a Pull Request for your changes to be added.
Lets get started!!!
In your browser, navigate to: https://github.com/apache/shiro
Fork the repository by clicking on the ‘Fork’ button on the top right hand side.
The fork will happen and you will be taken to your own fork of the repository.
Copy the Git repository URL by clicking on the clipboard next to the URL on the right hand side of the page under ‘HTTPS clone URL’.
You will paste this URL when doing the following
git clone command.
On your computer, follow these steps to setup a local repository for working on Apache Shiro:
$ git clone https://github.com/YOUR_ACCOUNT/shiro.git $ cd shiro $ git remote add upstream https://github.com/apache/shiro.git $ git checkout main $ git fetch upstream $ git rebase upstream/main
It is important that you create a new branch to make changes on and that you do not change the
main branch (other than to rebase in changes from
In this example I will assume you will be making your changes to a branch called
feature_x branch will be created on your local repository and will be pushed to your forked repository on GitHub. Once this branch is on your fork you will create a Pull Request for the changes to be added to the Apache Shiro project.
It is best practice to create a new branch each time you want to contribute to the project and only track the changes for that pull request in this branch.
$ git checkout -b feature_x (make your changes) $ git status $ git add . $ git commit -a -m "descriptive commit message for your changes"
-bspecifies that you want to create a new branch called
feature_x. You only specify
-bthe first time you checkout because you are creating a new branch.
feature_xbranch exists, you can later switch to it with only
git checkout feature_x.
It is important that you maintain an up-to-date
main branch in your local repository. This is done by rebasing in the code changes from
upstream/main (the official Apache Shiro project repository) into your local repository. You will want to do this before you start working on a feature as well as right before you submit your changes as a pull request. I recommend you do this process periodically while you work to make sure you are working off the most recent project code.
This process will do the following:
mainbranch with the
upstream/mainso you have all the latest changes from the project
feature_xbranch so it is up-to-date with the upstream code
$ git checkout main $ git fetch upstream $ git rebase upstream/main $ git checkout feature_x $ git rebase main
feature_xbranch is up-to-date with all the code in
When you are happy with your changes and you are ready to contribute them, you will create a Pull Request on GitHub to do so. This is done by pushing your local changes to your forked repository (default remote name is
origin) and then initiating a pull request on GitHub.
IMPORTANT: Make sure you have rebased your
feature_xbranch to include the latest code from
upstream/mainbefore you do this.
$ git push origin main $ git push origin feature_x
Now that the
feature_x branch has been pushed to your GitHub repository, you can initiate the pull request.
To initiate the pull request, do the following:
mainand will be from your
If you are requested to make modifications to your proposed changes, make the changes locally on your
feature_x branch, re-push the
feature_x branch to your fork.
The existing pull request should automatically pick up the change and update accordingly.
feature_x branch has been committed into the
upstream/main branch, your local
feature_x branch and the
origin/feature_x branch are no longer needed. If you want to make additional changes, restart the process with a new branch.
IMPORTANT: Make sure that your changes are in
upstream/mainbefore you delete your
You can delete these deprecated branches with the following:
$ git checkout main $ git branch -D feature_x $ git push origin :feature_x