Skip to content

Commit 40f889e

Browse files
authored
Add issue and PR templates, clarify guidelines (#1297)
1 parent 6adbbd9 commit 40f889e

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

.github/ISSUE_TEMPLATE.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!--
2+
Thanks for submitting an issue to AssemblyScript! Please take a moment to
3+
read the contributing guidelines linked below to get off to a good start 🙂
4+
-->

.github/PULL_REQUEST_TEMPLATE.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!--
2+
Thanks for submitting a pull request to AssemblyScript! Please take a moment to
3+
review the contributing guidelines linked below, and confirm with an [x] 🙂
4+
-->
5+
6+
7+
8+
9+
10+
- [ ] I've read the contributing guidelines

CONTRIBUTING.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,20 @@ Submitting Pull Requests
3535

3636
Instructions are similar to those for bug reports. Please provide the following information:
3737

38+
* If this is not a trivial fix, consider **creating an issue to discuss first** and **later link to it from the PR**.
3839
* Use a **clear and descriptive title** for the pull request.
39-
* Provide a **description of the suggested changes** in as many details as necessary.
40+
* Provide a **description of the changes** in as many details as necessary.
4041
* **Document your new code** where necessary.
4142
* Please **refrain from refactoring (unrelated code)** as it makes your pull request easier to review.
4243
* **Create tests for your new code** where necessary. For creating or updating tests, please see the [Test Instructions](./tests).
4344

44-
Before submitting your pull request, please make sure that the following conditions are met:
45+
Before submitting your pull request, also make sure that the following conditions are met:
4546

4647
* Your new code **adheres to the code style** through running `npm run check`.
4748
* Your new code **passes all existing and new tests** through running `npm run test`.
4849
* Your PR **excludes distribution files** in `dist/**`.
4950
* You appended yourself to the **list of contributors** in the [NOTICE](./NOTICE) file.
51+
52+
Please note that if a pull request is rather complicated, i.e. touches lots of internals, or became stale, it is not uncommon that a core contributor performs the final integration to get it done in good conscience while naming you as a co-author.
53+
54+
Thank you!

0 commit comments

Comments
 (0)