tiOPF Code Submission guidelines
tiOPF uses Git to manage all source code. Various parts of this project have been separated into 6 Git repositories.
- Code - the main framework source code
- Applications - various utility applications are large sample apps
- Docs - the framework's API Class documentation
- Website - the HTML source for this website
- 3rdParty - some 3rd party components, but this will be phased out and removed at some point.
- Demos - source code from examples listed on the website, or some of the legacy demos.
The Git repository URL information can be found by following the links found on this page: http://sourceforge.net/p/tiopf/_list/git
To stand a greater chance of having your changes successfully submitted, the following list of
guidelines needs to be followed.
- Make sure your local repository is up to date before you start working on a new feature or bug fixes.
Type: git pull origin
- Always do your work in a feature branch! No matter how small, keep each feature or bug fix
in a separate branch. Important!
- Make sure there are no conflicts and that everything compiles.
- Write unit tests for new feature you added. Important!
- Run all the unit tests to make sure you broke nothing. Important!
- If it is a new feature, supply a reasonable explanation in your commit comments or as a post
to the newsgroup, so we can extract that information and add it to the documentation. To save us
the work, you can always supply patches for the documentation too. ;-)
- Publish your feature branch somewhere public (eg: your personal Github account), or generate
a set of patch files using Git. A public personal repository is the preferred option, but if
you must, see git help format-patch on how to create
a set of patch files from your feature branch.
Can I please emphasise the importance of (2), (4) and (5)