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 Webdav trunk code:
- svn co https://webdav-servlet.svn.sourceforge.net/svnroot/webdav-servlet webdav-servlet
- Send a message to the Webdav Servlet 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
- Contributions should pass existing unit tests
- New unit tests should be provided to demonstrate bugs, fixes and new functionality
- Run the build including the tests and ensure that you can build a distribution.
- Create a patch
- Make sure you code is added to svn e.g.
svn add src/.../NewClass.java - Create a patch file
svn diff > webdav-servlet-1234.patch - where 1234 is the Jira issue number
- 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 -p0 < my-patch.patch - Attach your patch file to a Jira issue