-
Notifications
You must be signed in to change notification settings - Fork 304
Code Submission Rules
Anewbe edited this page Dec 3, 2017
·
10 revisions
Rules:
- This is always subject to change. As the needs of the server change, this will be updated.
- The Development and Server Staff have final say in what code gets merged, and what code does not.
- Anyone is free to contribute to the codebase, unless specifically prohibited. The Server and Development Staff reserve the right to deny PRs from contributors who have repeatedly added bad or sneaky code.
- Please make use of the information on the Wiki tab of our GitHub, it helps us help you fix whatever issues you may be having. (https://github.com/PolarisSS13/Polaris/wiki)
- Most features will be not be merged for at least 24 hours after being posted. This is to allow time for discussion by the staff and community. Bugfixes may be merged before that time, at the Development Staff’s discretion.
- Development Staff are not to merge their own PRs, excepting certain circumstances, such as critical bugfixes or permission from Head Staff.
- List your changes in the first post of your PR. Modified sprites, especially, take a long time to review if you don’t specifically name them in your opening comment.
- Compile, run, and test your code before committing. This will catch many of the most obvious bugs and runtimes that show up.
- Never assume your code will be merged. We greatly appreciate the work our non-Developer coders do, but not everything will make it in.
- If you are unwilling to correct your code, should it be merged and issues found, it will be removed.
Suggestions:
- Discuss your ideas with the Staff before you begin coding. It’s much simpler for the staff to discuss and decide on ideas, rather than actual code, and it saves everybody time.
- Keep your Pull Requests simple, specific, and serious, ie: adding one feature, fixing one bug, or changing a few minor things in the same general code. The more complicated your PR, the longer it takes to get reviewed and discussed.
- Please make changes that have been requested by the Development Staff. If you are unable or unwilling to make these changes, the Development Staff may close your PR.
- Please be patient. New features, especially those that have not been previously discussed, take time to assess and discuss. The Development Staff will attempt to keep the PR’s creator informed on the status of the decision.
- Don’t be discouraged if your code isn’t merged. Not everything makes it in, but we really do appreciate the work that gets done.