]> git.deb.at Git - rhonda/impostor.git/commitdiff
Update documentation
authorAeonLucid <aeonlucid@outlook.com>
Sun, 25 Oct 2020 04:48:31 +0000 (05:48 +0100)
committerAeonLucid <aeonlucid@outlook.com>
Sun, 25 Oct 2020 04:48:31 +0000 (05:48 +0100)
.github/PULL_REQUEST_TEMPLATE.md [new file with mode: 0644]
CONTRIBUTING.md [new file with mode: 0644]
README.md

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644 (file)
index 0000000..f189e76
--- /dev/null
@@ -0,0 +1,7 @@
+### Description
+
+
+
+### Closes issues
+
+- #
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..16583a3
--- /dev/null
@@ -0,0 +1,22 @@
+# Contribute guidelines
+
+We are always looking for people to help improve Impostor.
+
+## Code
+
+- If you are implementing or fixing an issue, please comment on the issue so work is not duplicated.
+- If you want to implementing a new feature, create an issue first describing the issue so we know about it. We are always open for discussion or questions on [Discord](https://discord.gg/Mk3w6Tb).
+- Don't commit unnecessary changes to the codebase or debugging code.
+- Write meaningful commits or squash them.
+- Please try to follow the code style of the rest of the codebase. An `.editorconfig` file has been provided to keep consistency.
+
+## Pull requests
+
+- Only make pull requests to the `dev` branch.
+- Only implement one feature per pull request to keep it easy to understand.
+- Expect comments or questions on your pull request from the project maintainers. We try to keep the code as consistent and maintainable as possible.
+- Each pull request should come from a new branch in your fork, it should have a meaningful name. 
+- We try to respond to pull requests as fast as possible. If you think we might have missed it, let us know on [Discord](https://discord.gg/Mk3w6Tb).
+
+
+If you have any questions, let us know.
\ No newline at end of file
index 2693ab3ccc28d25e11dbcd32777afd063b837b99..ce8dd6251235ab1b0efa7d1d47ae6bdae281a2eb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -43,7 +43,8 @@ See the [docs](docs/Running-the-server.md) for instructions on how to set it up.
 
 ## Contributing
 
-If you want to contribute to Impostor, make sure you work on and target the `dev` branch. That is where the latest changes will be. 
+See [CONTRIBUTING](CONTRIBUTING.md).
+
 
 ## License