Submitting Patches

From Bandit-project.org

1 Submitting Patches

Submitting Patches

If you submit a patch, it's always best to create the patch against the current snapshot version of the code. To do it:

Check out the source code from the repository (see Download).
Make the changes you want to make.
Follow the bandit best practices.
Run 'svn diff > change.patch' at the directory of the componant you changed.

If you cannot use this, then make sure you have the source for the latest release, and do the following:

Copy the file before you edit it.
Make the changes you want to make and save the file.
Follow the bandit best practices.
On the command line type diff -u oldfile.cs newfile.cs > vardec.patch. The name of the patch should be something quick which describes what you fixed.

If the patch fixes a bug, it's better to create a bug attach the patch to the bug. If you're patching against a pre-existing bug, just attach to the bug. Otherwise you can just send the patch to the Mailing List.

[edit]

Best Practices

All changes and new features should follow generally accepted best practices for development including:
- Code follows the coding guidelines.
- All targets build.
- Code has be peer reviewed.
- Existing junit tests pass and for new features there are new unit tests.
- Notification and cordination of the change/upload.
- It is also nice if static code analysis tools have been run (lint4j or others)

[edit]