diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d23261e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing to Serpentity + +At this moment this is a pet project and not really thought out a lot, +it may not be that active but I appreciate any contribution. + +## The objective of serpentity + +It's an entity-component-system library for node. A goal is to +be bare but extendable: You can create reusable components that can be +shared with other serpentity users, but they should live outside of the +core. Any improvements to performance and testing welcome. + +## How to contribute + +Above All: Be nice, always. + +* Ensure the linter shows no warnings or errors +* Don't break the CI +* Make the PRs according to [Git Flow][gitflow]: (features go to + develop, hotfixes go to master) + +[gitflow]: https://github.com/nvie/gitflow |