Struts uses Git and to manage the repository the git-flow was adopted, to read more about that please follow the links below:
First step is to install git-flow AVH Edition locally on your box, please follow the steps from this link
Now you can clone Struts repository locally
git clone https://git-wip-us.apache.org/repos/asf/struts.git
After cloning the repository locally you must initialize git-flow:
git flow init -d
Please remember that
master branch cannot be modified directly from now on!
If you aren’t a committer you must use this link below or mirror at GitHub
git clone git://git.apache.org/struts.git struts-copy
Please read carefully, this is very important!
If you prepared a patch to solve security issue in Apache Struts, in the first step contact us via Security Mailing List. Don’t publish any information about possible vulnerability. Thus will allow us coordinate the work and review if the information about issue can be disclosed publicly. We don’t want to inform hackers before we can protect our users :-)
Contributing with GitHub
Using GitHub mirror is the simplest way to contribute to Apache Struts if you are not a member of Struts Comitters group.
First you must have an account created at GitHub to be able perform the next step. If you don’t, go ahead and create one just right now! Please remember to setup SSH keys and test them!
When ready go to https://github.com/apache/struts and click
in top right corner. This will fork Apache Struts repository and will create your private (but public) repository
with the source code.
Next step is to clone your repo locally, information how to do this you will find on right sidebar of your repo
SSH clone URL headline.
Now you are ready to work with Apache Struts code base. Perform your changes, commit them and next push to GitHub! Remember: commit in Git is different than commit in Subversion!
With your changes pushed to GitHub you can prepare a Pull Request (short: PR). Go to Apache Struts mirror - https://github.com/apache/struts - then to Pull request and hit New Pull Request button.
If not already selected, click on
compare across forks. Right now you must select from the dropdowns on right
your fork and branch to compare the differences with Apache Struts develop branch.
Create Pull Request button and you are done!
How to merge Pull Requests
This section is for committers only who want to merge incoming Pull Requests. Please remember that the repo at GitHub is read-only, we (committers) have limited rights to it.
To merge PR please add GitHub as a new remote to your local copy
git remote add github email@example.com:apache/struts.git
then you can fetch the PR localy and put it under a branch
git fetch github pull/28/head:some-branch
githubis remote name
28is Pull Request id (https://github.com/apache/struts/pull/28)
some-branchlocal branch name, it can be the same as used to create the PR
now you can switch to this branch and test, review it
git checkout some-branch
after reviewing, switch back to the
develop branch and merge
git checkout develop git merge some-branch -m "WW-XXXX Merges #28 which resolves ..."
-m you can define your own merge message, it’s a good way to link merge commit with ticket in JIRA
git branch -d some-branch
remove the branch as it isn’t needed anymore
after pushing changes,
asfbot will close the PR at GitHub.
Google’s Patch Reward program
During SFHTML5 Google announced that they adding the Apache Struts project to the Google’s Security Patch Reward Program.
What does it mean?
If you prepared a patch that eliminates a security vulnerability or improves existing security mechanism you can get a bounty :-) You will find more details on the Google’s blog or under the link above, just to give you a quick guideline how does it work:
- prepare a patch and submit it to our JIRA, it can be a Pull Request on GitHub as well, but must reference the JIRA ticket.
- let us know that you did something great, post a message to Struts Dev mailing list
- we will review the patch and if it’s a real great thing then we will merge it into our code base
- just wait on official release of the Apache Struts and now you can request the reward from Google :-)
If you are concerned that your patch can disclose a security vulnerability, instead of submitting it as a ticket, send it directly to the Struts Security team. This will give us the possibility to prepare a new release with your patch in secret.
Have fun and code!