git.r.bdr.sh - rbdr/sumo/blob - CONTRIBUTING.md

   1 # Contributing to Sumo
   2
   3 This game is currently a personal project that is being built without
   4 a lot of direction. While contributions are currently not expected,
   5 any input, improvement or help is appreciated.
   6
   7 ## The objective of Sumo
   8
   9 Currently: To build a game of sumo. This hopefully will take more shape
  10 as the project gets built.
  11
  12 ## How to contribute
  13
  14 Above All: Be nice, always.
  15
  16 * Ensure the linter shows no warnings or errors
  17 * Don't break the CI
  18 * Make the PRs according to [Git Flow][gitflow]: (features go to
  19   develop, hotfixes go to master)
  20
  21 [gitflow]: https://github.com/nvie/gitflow