Here is a checklist that will help in making a contribution easy for both the contributor and the core developers that have to review the contribution.
- Checkout Katta trunk code:
- git clone https://github.com/sgroschupf/katta.git
- Send a message to the Katta mailing list, or file a bug report in Jira to describe your proposed changes and check that they fit in with what others are doing
- Make the code change
- Add APL 2 License headers, note all your work will be contributed as Apache License 2.
- All public classes and methods should have informative
Javadoc comments - Do not use @author tags
- Code should be formatted according to Katta’s formatting standard (refer to the file katta_formatting.xml which is used with Eclipse and located under the project’s root directory).
- Contributions should pass existing unit tests
- New unit tests should be provided to demonstrate bugs, fixes and new functionality
- You need to decide whether any new code should be submitted to the main sources or whether it should go under extras - Katta’s contribution folder
- Run the build including the tests and ensure that you can build a distribution.
- Create a patch
- Make sure you code is added to git e.g.
git add src/.../NewClass.java - Create a patch file
git format-patch master --stdout >~/Desktop/KATTA-78-v2.patch
- Make sure you code is added to git e.g.
- Inspect your patch file and check that :
- You did not reformat code
- Unused code is removed
- You have commented code whose function or rationale is not obvious
- Updated documentation
- Test your patch file patch:
- (overview it)
git apply --stat fix_empty_poster.patch - (dry run it it)
git apply --check fix_empty_poster.patch - (apply it)
git apply --signoff fix_empty_poster.patch
- (overview it)
- Attach your patch file to a Jira issue
- *Alternatively* fork Katta and send and pull request!