Contributor Guide: Difference between revisions
From Sojourn
m Adds a - |
|||
| Line 1: | Line 1: | ||
==<center>Contribution guidelines</center>== | ==<center>Contribution guidelines</center>== | ||
<hr> | <hr> | ||
<center>'''Hardline | <center>'''Hardline rules'''</center><hr> | ||
* PRs may be put forth are not necessarily supported by their creator. They may be made on behalf of others or even just on a notion. All are free to make Pull Requests for consideration and ultimate responsibility for the inclusion(or exclusion) on content falls squarely on the head of the Lead-Dev. No coder should be shouted at solely for a change they've requested.<br> | |||
*Players and admins shall not dictate to devs or contributors how they 'must' spend their time coding. While changes will invariably become necessary for any number of reasons(story arcs, balance, etc) these changes should either be requested, or directly given to the lead-dev to determine implementation. At the end of the day, all developers who work on this project do so of their own volition and in their free time. <hr> | |||
==== <center>Guidelines</center> ==== | ==== <center>Guidelines</center> ==== | ||
#Guideline - All are free to work on content as they please, but in the interest of not wasting ones time it is often in the best interest to discuss possible PRs before the work is done so as to gauge concerns. | #Guideline - All are free to work on content as they please, but in the interest of not wasting ones time it is often in the best interest to discuss possible PRs before the work is done so as to gauge concerns. | ||
Revision as of 02:47, 16 May 2022
Contribution guidelines
- PRs may be put forth are not necessarily supported by their creator. They may be made on behalf of others or even just on a notion. All are free to make Pull Requests for consideration and ultimate responsibility for the inclusion(or exclusion) on content falls squarely on the head of the Lead-Dev. No coder should be shouted at solely for a change they've requested.
- Players and admins shall not dictate to devs or contributors how they 'must' spend their time coding. While changes will invariably become necessary for any number of reasons(story arcs, balance, etc) these changes should either be requested, or directly given to the lead-dev to determine implementation. At the end of the day, all developers who work on this project do so of their own volition and in their free time.
Guidelines
- Guideline - All are free to work on content as they please, but in the interest of not wasting ones time it is often in the best interest to discuss possible PRs before the work is done so as to gauge concerns.
- Guideline - Content should be made with respect to the setting, atmosphere, balance and performance impact.
- Guideline - Changelogs MUST be detailed. While this is down to your discretion as to how much or little is 'relevant' , the most pertinant details should be laid out in clear and easy to read. E.G a new gun should have its damage, penetration and accuracy detailed. By following this guideline we hope to ease the process of balancing new content without stimying its addition.
- Guideline -In the same way as the above, anything more than minor content should be thoroughly Q.A tested to ensure no bugs, erroneous behaviors, runtime, et cetera are going to cause immediate issue.
- Guideline - PRs should contain, if any - generalized performance impact. I.e how much performance this will take amount of loops running or active cost to maintain this feature.
