Skip to content

Commit 134ad7a

Browse files
authored
elaborated on contribution guidelines (pawn-lang#458)
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.
1 parent e805a9c commit 134ad7a

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Contributing to the Pawn Compiler
22

3-
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.
4-
5-
Please note we have a code of conduct, please follow it in all your interactions with the project.
3+
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!
64

75
## Pull Requests
86

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ Never pull to `master` - always pull to `dev` or a relevant feature branch.
1212

1313
**Which issue(s) this PR fixes**:
1414

15-
<!--GitHub tip: using "Fixes #<issue number> will automatically close the issue upon being merged-->
15+
<!--
16+
Please ensure you have discussed your proposed changes before committing time to writing code!
17+
18+
GitHub tip: using "Fixes #<issue number> will automatically close the issue upon being merged
19+
-->
1620

1721
Fixes #
1822

readme.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,12 @@ Parallel installation is supported.
8686

8787
If you are a [sampctl][sampctl] user, you are already using this compiler!
8888

89-
### Build From Source
89+
### Building from Source
9090

91-
If you are interested in contributing or just using a specific version, check
92-
out [this page][build_source] for instructions for compiling for your platform.
91+
If you are interested in contributing then please first read
92+
[this document][contributing] and ensure you have discussed your proposed
93+
changes before writing any code. Check out [this page][build_source] for
94+
instructions for compiling for your platform.
9395

9496
## Background
9597

@@ -122,4 +124,6 @@ seems to be based on an older release of Pawn.
122124
https://ci.appveyor.com/project/Southclaws/compiler/branch/master/artifacts
123125
[compat]: https://github.com/pawn-lang/compiler/wiki/Compatibility-mode
124126
[sampctl]: http://bit.ly/sampctl
127+
[contributing]:
128+
https://github.com/pawn-lang/compiler/tree/master/.github/CONTRIBUTING.md
125129
[build_source]: https://github.com/pawn-lang/compiler/wiki/Building-From-Source

0 commit comments

Comments
 (0)