Add basic contributing docs #664
Conversation
F1F7Y
added
needs code review
Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
uniboi
removed
the
needs code review
| ### Comment your code | ||
| - If you're adding a new file you should add a doc comment noting what the file does and its origin | ||
| ```cpp | ||
| ///----------------------------------------------------------------------------- | ||
| /// Origin: Northstar | ||
| /// Purpose: handles server-side rui | ||
| ///----------------------------------------------------------------------------- | ||
| ``` | ||
| Alternative to `Origin: Northstar` would be `Origin: Respawn` | ||
| - Each function should have a header doc comment | ||
| ```cpp | ||
| ///----------------------------------------------------------------------------- | ||
| /// Sends a string message to player | ||
| /// Returns true if it succeeded | ||
| ///----------------------------------------------------------------------------- | ||
| bool function NSSendInfoMessageToPlayer( entity player, string text ) | ||
| ``` | ||
| ### Functions | ||
| - Functions should have spaces in the parentheses | ||
| ```cpp | ||
| bool function NSSendInfoMessageToPlayer( entity player, string text ) | ||
| ``` | ||
| - If a function need to be threaded off using `thread` it should have a `_Threaded` suffix |
There was a problem hiding this comment.
Looking over this again, I think it might make more sense to just put this into ModdingDocs and then link to ModdingDocs from here. It should be mentioned in ModdingDocs anyway and that way if we do any changes, we only need to update one location (ModdingDocs) as opposed to two locations (this file and ModdingDocs) ^^
There was a problem hiding this comment.
I disagree, guidelines how to coontribute to the repository should be in the repository itself. Can't hurt to have this in the modding docs as well but this should be in here
There was a problem hiding this comment.
In that case we should link from the ModdingDocs to here. Basically I just want to avoid duplicating information as based on experience it is more than likely that one of the two won't be updated when something changes ^^
|
Honestly before keeping this in PR hell forever, might make more sense to merge now as-is and then adjust afterwards, moving stuff between docs and here depending on how we feel about it. Just need to double check with release repo, whether or not we manually pick the files we want to keep for release or remove the ones we don't want and based on that I need to update CI in release repo accordingly. |
|
Yeah, looks like it requires a change in release repo CI as well :dread: EDIT:
|
Adds docs with guidelines for contributing.