So you want to contribute to R2API? Great! We invite all to contribute to R2API to make modding easier for mod developers. Here are a few guidelines in order to make your contribution as easy as possible!
To be able to maintain the project without breaking too much of a sweat, we try to stick to the following rules:
-
No implementation of any in-game functionality, unless deemed absolutely necessary for mod compatibility purposes, note that this does not apply to the R2API.Test package, as this package is purely for debugging / testing R2API functionalities.
-
Duplicating code from the game assemblies should be avoided whenever possible.
-
Non exposed code should be cleaned up each commit. There's no point in keeping it around as comments - that's what Version Control is for.
-
Since removing released exposed code is only possible in a major release, candidates should be marked as obsolete but not removed.
Pull requests are welcomed but may be rejected for the reasons mentioned above. Please try to maintain high code quality and use the .editorconfig that is included in the repo. PRs with poor code quality may be denied.