From 8c51b0bfd76d4ac84fc76dd01118c64135499cd4 Mon Sep 17 00:00:00 2001 From: Southclaws Date: Thu, 8 Feb 2018 14:22:13 +0000 Subject: [PATCH] some .github housekeeping --- .github/CONTRIBUTING.md | 27 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 36 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 33 +++++++++++++++++++++++++++++ 3 files changed, 96 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..1d06e52 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing to the Pawn Compiler + +When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Requests + +### Branches + +This repository follows a simple feature branch with a dev branch for staging. `master` should always reflect the latest release and `dev` is the staging branch for the next version. All other features must be worked on in feature branches. + +### Pull Contents + +Ensure you only commit source files, test resources or other portable assets. Pulls that contain editor configs, executables, libraries and other non-source files will be rejected unless there's a good reason. + +## Issues + +### Questions + +Feel free to open issues that are just questions, they will be marked as a question and answered by a maintainer or community member. + +However, do not ask about compiler errors and warnings that are the fault of Pawn code. This repository is purely for discussing the compiler itself, it is not a Pawn help channel. That being said, if you have come across an error or warning you did not expect from the given code, open an issue and we can investigate if it's a bug in the compiler. + +### Reproductions + +Always submit code to reproduce a bug, if your gamemode code is private then it's up to you to create a minimal reproduction case. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..bafd4db --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,36 @@ + + +**Is this a BUG REPORT, FEATURE REQUEST or QUESTION?**: + +* [ ] Bug Report +* [ ] Feature Request +* [ ] Question + +**What happened**: + +**What you expected to happen**: + +**How to reproduce it (as minimally and precisely as possible)**: + +**Anything else we need to know?**: + +**Environment**: + +* Operating System +* Compiler version +* How are you invoking the compiler? Pawno, Sublime, vscode, sampctl or command-line? +* If using sampctl, the version number diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..1f25e5d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,33 @@ + + +**What this PR does / why we need it**: + +- + +**Which issue(s) this PR fixes**: + + + +Fixes # + +**What kind of pull this is**: + + + +* [ ] A Bug Fix +* [ ] A New Feature +* [ ] Some repository meta (documentation, etc) +* [ ] Other + +**Additional Documentation**: + +