diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1d06e52..a640e5b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,8 +1,6 @@ # 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. +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! ## Pull Requests diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1f25e5d..8b11849 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,7 +12,11 @@ Never pull to `master` - always pull to `dev` or a relevant feature branch. **Which issue(s) this PR fixes**: - + Fixes # diff --git a/readme.md b/readme.md index 5c4e458..b2a6e0d 100644 --- a/readme.md +++ b/readme.md @@ -86,10 +86,12 @@ Parallel installation is supported. 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 -out [this page][build_source] for instructions for compiling for your platform. +If you are interested in contributing then please first read +[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 @@ -122,4 +124,6 @@ seems to be based on an older release of Pawn. https://ci.appveyor.com/project/Southclaws/compiler/branch/master/artifacts [compat]: https://github.com/pawn-lang/compiler/wiki/Compatibility-mode [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