Home

Welcome to the foxsi-smex wiki!

IDL Coding Standards

In order to maintain a high quality code base here we describe a set of basic rules for code in this repository

• All functions are required to have documentation strings in the same file and before the function definition
• All function must be named with the prefix foxsi_ to prevent namespace collisions.
• All binary data or data files should be placed in the data folder and should not be in any of the code folder

Code Review Standards

Code will be accepted into this repository using the following procedures.

• All code must be submitted through a pull request.
• Code must abide by the coding standards (see above) before being accepted.
• Pull requests should be reviewed (commented on) within 3 days of the pull request. If this is not met than a lead developer may go ahead and accept the pull request unilaterally.
• Submitters should respond and provide fixes to their code based on comments within a reasonable period of time otherwise the request will be deemed abandoned and closed.