Contributing Changes

Workflow overview

1. Create a GitHub account.
2. Fork the main SiteMesh repository. Anyone can do this at anytime.
3. Do whatever you want in your fork. Make modifications, experiments, add contributors, branch, commit, blog about your modifications, etc. It’s your repository.
4. If you want your changes integrated, mail the SiteMesh Team, and we can review your changes, give feedback and guide you through the process.

Details

• GitHub guide to forking
• When making a Pull Request be sure to select joewalnes and sitemesh as the recipients.
• All code committed to the main SiteMesh repository must be licensed under the Apache Software License 2.0
• Engaging the SiteMesh team:
• Sign up to the developer mailing list (if you are concerned about spam, you can opt to not receive emails, but you still need to join to post) and send us an email that:
  • Briefly introduces yourself.
  • Describes the change(s) you want to integrate.
  • Explains why they should be part of the main code base.
  • Confirms that all new code is licensed under the Apache Software License v2 and conforms to the Coding Guidelines.

Tips for getting changes integrated

• Although you can get most of the way through the process without involving the SiteMesh team, you may want to drop an email to the developer mailing list.
• Forking repositories on GitHub is a lightweight and encouraged process. Don’t be afraid – even if it’s just for experimental stuff that may never get contributed back.
• Please follow the Coding Guidelines.
• Don’t be offended if you are asked many questions, and to make changes to the code.
• Your change may be rejected or postponed for a number of reasons – the team will give you feedback as to why. If this happens, don’t be disheartened – it can help for you to publicize the changes, get more user feedback, and come back again later.
• If you’re new to Git or GitHub, check out the GitHub guides.