diff options
| author | Rubén Beltrán del Río <ben@nsovocal.com> | 2018-04-20 16:41:25 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-04-20 16:41:25 -0500 |
| commit | 11be5ebabcdab8272d938f7b90ef0ea9be29a421 (patch) | |
| tree | b8ee06be115b2bbc1a74185711c96ba334bfdab4 /CONTRIBUTING.md | |
| parent | 0ac89474ea22e706eb54c6ed4630a3337d438876 (diff) | |
Initial Project Setup (#2)
* 🔧 Add initial package.json
* 🔧 Add eslint config
* 🔧 Add assets target dir to gitignore
* 🔧 Add webpack config
* Add a contributing guide
* Add the wrapper application
* Add autogenerated docs
* Add travis config
* Add changelog
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..253ff9c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing to Sumo + +This game is currently a personal project that is being built without +a lot of direction. While contributions are currently not expected, +any input, improvement or help is appreciated. + +## The objective of Sumo + +Currently: To build a game of sumo. This hopefully will take more shape +as the project gets built. + +## 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 |