diff options
| author | Rubén Beltrán del Río <ben@nsovocal.com> | 2017-04-12 00:18:35 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-04-12 00:18:35 -0500 |
| commit | b3b840f89948d96aa28760fc5cf41c384488f6a6 (patch) | |
| tree | e6741096f29440a343323a5d7542f5caf1aceacb /CONTRIBUTING.md | |
| parent | d071276e2426c4180e44debe8b92ad16cbbc414f (diff) | |
Feature/code update (#1)
* Updates code for new eslint config
* Remove gulp and babel files
* Remove dist
* Remove dist
* Add contributing file
* Fix references to collections / tests
* Convert tests to lab
* Add travis file
* Add missing line
* Test CI on node 6
* Removes browser test
* Properly includes local serpentity in test
* Rename to use orgs in npm
* Add changelog
* Add support files / removed dist to changelog
* Add yarn.lock file
* Iterate using object.keys instead of values
* Correct typo in typeName matching
* Add webpack to generate the dist files
* Add webpack config
* Add dist files
* Bump version
* Link to ash
* Updates CHANGELOG
* Add CI badge
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 |