Add new contributing guidelines

This commit is contained in:
Lucas Nicodemus 2015-05-01 09:57:18 -06:00
parent 03c1182f27
commit e6f7877551

View file

@ -19,6 +19,10 @@ Required:
- Use tabs, not spaces.
- Use UpperCamelCase for public function names.
- Prior to developing, make sure your clone is up to date with general-devel. This means that we don't get merge commits in your pull request.
- Document all code with public access at minimum. Use the ```<param name="Name">Description</param>``` style -- do not repeat the param type or name in the xml comment field.
- Use explicit type declaration (```int, long, float```) when the type is not easily inferred (such as return types).
- Use implicit type declaration (```var```) when the type is easily inferred (such as private lists, temporary values, etc).
- Use Microsoft code conventions on variable naming (including ```_name``` for private members).
### Dev Team Guidelines
@ -30,7 +34,6 @@ These guidelines are to be followed by all developers with commit level access t
- This is not a professional software product. Your results may vary with code quality, buginess, etc. Do not complain about something -- just fix it and move on.
- __Do not force push the repo__, or you will be removed.
- __Do not revert commits__, unless you have sign-off from one other developer (the two-man rule), or you will be removed.
- __This is not a meritocracy.__
- Deprecation of a function guarantees that it will exist in the given release, but may be removed, at any time following, from subsequent releases without further warning. Warning should be given in the release thread prior to it going live.
- Updates should be discussed, via pull request of a version tick, prior to release. Only after consensus from active contributing community members has been given can a release happen.
- Breaking API changes (excluding removal of already deprecated and warned code) should be forewarned with a one week notice on the forums, which may be given at any time prior to release (as soon as a pull request for a version push has been made, an update can be warned).