1berry/pawn-compiler
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

elaborated on contribution guidelines (#458)

Browse Source 
This change just improves the wording around contribution in the readme, contributing and PR template to ensure contributors discuss proposed changes before actually writing any code to save time during code review.
This commit is contained in:
Barnaby Keene 2020-03-15 20:09:00 +00:00 committed by GitHub
parent e805a9c8f7
commit 134ad7a836
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/CONTRIBUTING.md vendored
View File

@ -1,8 +1,6 @@
# Contributing to the Pawn Compiler # 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. If you are proposing a new feature or fixing a bug of significant complexity, please do not write any code and propose your planned changes via an issue first! This saves _you_ time in case changes are required or the feature is rejected and it saves the _maintainers_ time as discussing proposals is generally easier than doing code review. Thank you!
Please note we have a code of conduct, please follow it in all your interactions with the project.
## Pull Requests ## Pull Requests

6
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -12,7 +12,11 @@ Never pull to `master` - always pull to `dev` or a relevant feature branch.
**Which issue(s) this PR fixes**: **Which issue(s) this PR fixes**:
<!--GitHub tip: using "Fixes #<issue number> will automatically close the issue upon being merged--> <!--
Please ensure you have discussed your proposed changes before committing time to writing code!
GitHub tip: using "Fixes #<issue number> will automatically close the issue upon being merged
-->
Fixes # Fixes #

10
readme.md
View File

@ -86,10 +86,12 @@ Parallel installation is supported.
If you are a [sampctl][sampctl] user, you are already using this compiler! If you are a [sampctl][sampctl] user, you are already using this compiler!
### Build From Source ### Building from Source
If you are interested in contributing or just using a specific version, check If you are interested in contributing then please first read
out [this page][build_source] for instructions for compiling for your platform. [this document][contributing] and ensure you have discussed your proposed
changes before writing any code. Check out [this page][build_source] for
instructions for compiling for your platform.
## Background ## Background
@ -122,4 +124,6 @@ seems to be based on an older release of Pawn.
https://ci.appveyor.com/project/Southclaws/compiler/branch/master/artifacts https://ci.appveyor.com/project/Southclaws/compiler/branch/master/artifacts
[compat]: https://github.com/pawn-lang/compiler/wiki/Compatibility-mode [compat]: https://github.com/pawn-lang/compiler/wiki/Compatibility-mode
[sampctl]: http://bit.ly/sampctl [sampctl]: http://bit.ly/sampctl
[contributing]:
https://github.com/pawn-lang/compiler/tree/master/.github/CONTRIBUTING.md
[build_source]: https://github.com/pawn-lang/compiler/wiki/Building-From-Source [build_source]: https://github.com/pawn-lang/compiler/wiki/Building-From-Source