From 11be5ebabcdab8272d938f7b90ef0ea9be29a421 Mon Sep 17 00:00:00 2001 From: Rubén Beltrán del Río Date: Fri, 20 Apr 2018 16:41:25 -0500 Subject: Initial Project Setup (#2) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 🔧 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 --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') 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 -- cgit