...
General recommendations
- Always create a JIRA issue.
- Use meaningful comments when doing a commit/push/pull request.
- Always mention the JIRA issue that is related to your commit (e.g., "Fix for JIRA-123").
- When doing a commit based on a patch from a contributor, make sure to mention the contributor name in the comment (e.g. "Fix for JIRA-123. (Contributor name)" ).
- Never commit incomplete changes (GIT is not a backup system).
- Working on experimental changes is encouraged, but in this case use a branch.
- Don't maintain Versions.txt anymore, we will extract release notes from JIRA starting from IzPack 4.0 and beyond.
- Subscibe to the developer mailing list to follow IzPack development conversations.
- Do not hesitate to pick new new JIRA issues: both the other developers and the issue submitter will thank you for the work!
- When you start working on an issue, don't forget to mark it as in progress so that we know that you're solving it!
- For developing workflow will be: Open -> In progress -> Resolution -> Resolved -> Closed
- For language file update: Open -> Resolved -> Closed
- For more information about an issue please visit: What is an Issue?
Using issues and documentation
- Always create a Always create a JIRA issue in case of bug, improvement or new feature. You can follow progess of your issue there.
- Don't send bigger patches, try to fork the master repository at Github and create a pull request instead.
If you can't send a pull request for some reason and you have a patch, then attach it to the JIRA issue.
Make sure you send you send a real diff-generated patch, not whole files or ZIPs with the modified files... (Several programs will generate this, for example: IntelliJ, Eclipse, Netbeans, TortoiseSVN,...) - Do not hesitate to attach screenshots and stack attach screenshots and stack traces.
- In case of a new feature proposal make sure to attach to attach documentation to an according JIRA issue.
- Subscribe to Subscribe to the developer mailing list if you want to follow IzPack development conversations.
- Respect code format styles! Otherwise we have a hard time trying to merge your code.
...
You should avoid long width lines. 80 characters is probably short nowadays. 100-120 characters looks like to be a good limit.
As of IzPack 5.0 we must guarantee to provide at least Java 6 compatibility for installer execution, use it as the language source and target version.
...