[rbdr/serpentity] / CONTRIBUTING.md

# 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
Commit	Line	Data
b3b840f8 RBR	1	# Contributing to Serpentity
	2
	3	At this moment this is a pet project and not really thought out a lot,
	4	it may not be that active but I appreciate any contribution.
	5
	6	## The objective of serpentity
	7
	8	It's an entity-component-system library for node. A goal is to
	9	be bare but extendable: You can create reusable components that can be
	10	shared with other serpentity users, but they should live outside of the
	11	core. Any improvements to performance and testing welcome.
	12
	13	## How to contribute
	14
	15	Above 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