some .github housekeeping

This commit is contained in:
Southclaws 2018-02-08 14:22:13 +00:00
parent 73b64e141f
commit 8c51b0bfd7
3 changed files with 96 additions and 0 deletions

27
.github/CONTRIBUTING.md vendored Normal file
View File

@ -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.

36
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,36 @@
<!--
This area is for:
- Bug reports
- Feature suggestions
- Questions directly regarding the compiler's implementation, command arguments
or usage. This is NOT a place to ask questions about compiler errors or
warnings you are getting UNLESS those errors or warnings are unexpected and
the result of a possible bug.
For any other questions, post on the SA:MP forum or the unofficial SA:MP
Discord server in the #programming channel.
The issues section of this repository is managed by @Southclaws who will assign
labels etc.
-->
**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

33
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,33 @@
<!--
Please ensure you have read the CONTRIBUTING.md document before submitting this
pull request. Requests that fail to follow enough of the guidelines will likely
be closed immediately with request to rectify the issues.
Never pull to `master` - always pull to `dev` or a relevant feature branch.
-->
**What this PR does / why we need it**:
-
**Which issue(s) this PR fixes**:
<!--GitHub tip: using "Fixes #<issue number> will automatically close the issue upon being merged-->
Fixes #
**What kind of pull this is**:
<!--Replace [ ] with [x] to mark the checkbox-->
* [ ] A Bug Fix
* [ ] A New Feature
* [ ] Some repository meta (documentation, etc)
* [ ] Other
**Additional Documentation**:
<!--
If your PR introduces a change that requires documentation, add it here so it can be added to the wiki.
Feel free to edit the wiki yourself once your PR has been accepted.
-->