From 7292a3eeb88bcbcb4552d3c645ee5eaf202059cc Mon Sep 17 00:00:00 2001 From: David Evans Date: Sat, 9 Sep 2017 14:45:51 +0100 Subject: [PATCH] Add github-specific contribution templates --- README.md | 8 ++++---- CONTRIBUTING.md => docs/CONTRIBUTING.md | 0 CREATE_A_GAME.md => docs/CREATE_A_GAME.md | 0 docs/ISSUE_TEMPLATE.md | 0 docs/PULL_REQUEST_TEMPLATE.md | 11 +++++++++++ 5 files changed, 15 insertions(+), 4 deletions(-) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (100%) rename CREATE_A_GAME.md => docs/CREATE_A_GAME.md (100%) create mode 100644 docs/ISSUE_TEMPLATE.md create mode 100644 docs/PULL_REQUEST_TEMPLATE.md diff --git a/README.md b/README.md index 6da0a83..b8b8d90 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ https://davidje13.github.io/koth-webplayer/test.htm ## Making Games -Check the [create-a-game](CREATE_A_GAME.md) guide for details on how to create -your own games using this framework. +Check the [create-a-game](docs/CREATE_A_GAME.md) guide for details on how to +create your own games using this framework. ## Aims @@ -43,5 +43,5 @@ This is early stages, and lots of functionality doesn't exist yet, or is rather quick-and-dirty, so it's likely that new games will need some changes to the engine itself. -Contributions are welcome! Check the [contributing guidelines](CONTRIBUTING.md) -for details. +Contributions are welcome! Check the +[contributing guidelines](docs/CONTRIBUTING.md) for details. diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/CREATE_A_GAME.md b/docs/CREATE_A_GAME.md similarity index 100% rename from CREATE_A_GAME.md rename to docs/CREATE_A_GAME.md diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..8802a3a --- /dev/null +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +Details of your pull request here - if you have fixed an issue, please reference +it with #issue-number. + + +Checklist: + +[ ] Any new Javascript files are listed in `test.htm`. +[ ] Tests are passing in Google Chrome. +[ ] Linting is passing. +[ ] No dead code is left behind. +[ ] I agree to release my code under the license of this project.