]> git.r.bdr.sh - rbdr/serpentity/blame_incremental - CONTRIBUTING.md
Modify docs for deprecation
[rbdr/serpentity] / CONTRIBUTING.md
... / ...
CommitLineData
1# Contributing to Serpentity
2
3At this moment this is a pet project and not really thought out a lot,
4it may not be that active but I appreciate any contribution.
5
6## The objective of serpentity
7
8It's an entity-component-system library for node. A goal is to
9be bare but extendable: You can create reusable components that can be
10shared with other serpentity users, but they should live outside of the
11core. Any improvements to performance and testing welcome.
12
13## How to contribute
14
15Above All: Be nice, always.
16
17* Ensure the linter shows no warnings or errors
18* Don't break the CI
19* Make the PRs according to [Git Flow][gitflow]: (features go to
20 develop, hotfixes go to master)
21
22[gitflow]: https://github.com/nvie/gitflow