Getting JSPWiki Source Code#
JSPWiki source codeContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png is maintained using Git.
Checkout the code using:
git clone http://github.com/apache/jspwiki.git jspwikiChange http to https if you are a developer intending to git push. You can check Getting started with Git at the ASFContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png for further information. Also, as it is hosted on GitHub, you can also fork and send your PRs from there.
In order to be able to commit on the github repos, the following steps must be taken:
- Enable 2FA on your github accountContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png
- Become part of the ASF org on github. If you have not done so already, visit id.apache.org and add your GitHub ID to your profile. An organisational invite will be sent to you via email shortly thereafter (within 30 minutes).
- Link ASF and GitHub accounts through https://gitbox.apache.org/setupContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png
Current repositories#
- https://github.com/apache/jspwikiContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png
- https://github.com/apache/jspwiki-asf-docsContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png
- https://github.com/apache/jspwiki-siteContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png
ASF git copies are on gitbox, like https://gitbox.apache.org/repos/asf/jspwiki.gitContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png.
Building JSPWiki#
Apache JSPWiki is a MavenContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png-based project and builds using the same commands as other Maven projects. The JSPWiki team maintains a cheat sheetContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png of common Maven tasks for this project. Current release is 2.10.5 and can be reached through the downloads page, with development going into 2.11.0.M1.
Coding standards:#
- Use the EclipseContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png and CheckstyleContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png formatters (both automatically incorporated when you run mvn eclipse:eclipse on the project.)
- Remove trailing whitespace and whitespace on empty lines
Commits:#
- All commits except those to the website or for releases should start with JSPWIKI-num: JIRA title. If committing a patch from a contributor the commit message should read JSPWIKI-num: JIRA title. Contributed by contributor's name.
- Try not to break the current build by making sure that trunk still builds before committing.
- Bump the version (in Release.java). Please see the versioning proposalContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png on which version number follows which one.
- Add a suitable ChangeLogContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png entry describing your change(s).
- When resolving the JIRA, be sure to set the fix version to the current next planned release version as this is used to create the release notes.
