-
Notifications
You must be signed in to change notification settings - Fork 138
Development Standards
mani-monaj edited this page Oct 4, 2011
·
9 revisions
From September 2011, all grSim development has been moved from Parsian's private SVN repo to github.
Please stick to these (incomplete list of) standards while doing development on grSim.
- The README file must outline all important aspects of the software, suggested sections: 1.1 Introduction including both link to the webpage and github repo. 1.2 Licence (Refer to Licence file) 1.3 Minimum System Requirements 1.4 Installation (Refer to Install file) 1.5 Usage (Refer to usage wiki page as extra information) 1.6 Changelog (Refer to Changelog file)
- The INSTALL file must discuss in details the required steps for installation.
- 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.
- The CHANGELOG file must include all changes made to the software during each milestone, details below.