Development Standards

General Info

From September 2011, all "grSim" development has been moved from Parsian's private SVN repo to github.

Standards

Please stick to these (incomplete list of) standards while doing development on grSim.

1. The README file must outline all important aspects of the software, suggested sections:

• Introduction including both links to the webpage and github repo.
• Licence (Refer to Licence file)
• Minimum System Requirements
• Recommended System Requirements
• Installation (Refer to Install file)
• Usage (Refer to Usage wiki page as extra information)
• Changelog (Refer to Changelog file)

2. The INSTALL file must discuss in details the required steps for installation.
3. The AUTHORS file must include all names of main developers and all other people who contributed the code to the project with their full name, institute name, email address and github profile address if available.
4. The CHANGELOG file must include all changes made to the software during each milestone, details below.

README

• [TODO] Convert README file to Markdown format.

INSTALL

• The install files should assume that the user is inexperienced.
• Include as much commands as possible to help the user.
• Include common mistakes.
• Include common issues on different system configurations.
• Include UPGRADE from previous versions information.

CHANGELOG

• Include all major and minor changes from the previous release
• Include credits for people that:
• Reported bugs
• Provided Patches
• Provided ideas

AUTHORS

This file must include two sections, main developers, who contribute regularly to the project and list of all people with their associations and contact info who provided patches and ideas.