Skip to content

Add issue and PR templates, clarify guidelines #1297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 29, 2020
Merged

Add issue and PR templates, clarify guidelines #1297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
cfb04b3
Add issue and PR templates, clarify guidelines
dcodeIO May 27, 2020
305a64f
contribution -> contributing
dcodeIO May 27, 2020
ef81fd4
add a checkbox
dcodeIO May 28, 2020
61150c4
maybe not on issues
dcodeIO May 28, 2020
7115c45
keep the good start on issues
dcodeIO May 28, 2020
efc8657
reorder
dcodeIO May 28, 2020
a623a33
reorder more
dcodeIO May 28, 2020
4ca2228
a pre-flight issue can be considered information
dcodeIO May 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!--
Thanks for submitting an issue to AssemblyScript! Please take a moment to
read the contributing guidelines linked below to get off to a good start 🙂
-->
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!--
Thanks for submitting a pull request to AssemblyScript! Please take a moment to
review the contributing guidelines linked below, and confirm with an [x] 🙂
-->

⯈
⯈
⯈

- [ ] I've read the contributing guidelines
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,20 @@ Submitting Pull Requests

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

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

Before submitting your pull request, please make sure that the following conditions are met:
Before submitting your pull request, also make sure that the following conditions are met:

* Your new code **adheres to the code style** through running `npm run check`.
* Your new code **passes all existing and new tests** through running `npm run test`.
* Your PR **excludes distribution files** in `dist/**`.
* You appended yourself to the **list of contributors** in the [NOTICE](./NOTICE) file.

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.

Thank you!