Skip to content

Commit b342cf6

Browse files
committed
Chore: Provide more contribution related details
* Add `ISSUE_TEMPLATE.md` and `PULL_REQUEST_TEMPLATE.md` templates. * Update `CODEOWNERS` list. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Ref #347 Ref https://github.com/blog/2111-issue-and-pull-request-templates Close #505
1 parent 04b7904 commit b342cf6

File tree

4 files changed

+119
-2
lines changed

4 files changed

+119
-2
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
#
44
# https://github.com/blog/2392-introducing-code-owners.
55

6-
* @alrra @austinkelleher @molant @patrick-steele-idem @sarvaje
6+
* @alrra @austinkelleher @molant @sarvaje

.github/ISSUE_TEMPLATE.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
<!--
2+
3+
This template is for bug reports. If you are reporting a bug,
4+
please continue on. If you are here for another reason, please
5+
see below:
6+
7+
1. How to propose a new rule:
8+
TODO
9+
10+
2. How to request a change:
11+
TODO
12+
13+
3. If you have any questions, please stop by our chatroom:
14+
https://gitter.im/sonarwhal/Lobby
15+
16+
[!] Notes:
17+
18+
* By leaving the following sections blank will make
19+
it difficult for us to troubleshoot and we may have
20+
to close the issue.
21+
22+
* sonar adheres to the JS Foundation Code of Conduct
23+
https://js.foundation/community/code-of-conduct.
24+
25+
-->
26+
27+
Please tell us about your:
28+
29+
## Environment
30+
31+
<!-- You get the version numbers for the following by running:
32+
33+
* sonar -v
34+
* node -v
35+
* npm -v
36+
37+
-->
38+
39+
* __`sonar` version:__
40+
* __`Node.js` version:__
41+
* __`npm` version:__
42+
43+
## `sonar` configuration
44+
45+
<details>
46+
<summary>sonar's configuration</summary>
47+
48+
<!--
49+
Note: The `sonar` configuration may be in a file named `.sonarrc`,
50+
or in the `package.json` file under the `sonarConfig` propery.
51+
52+
Paste those configurations below:
53+
-->
54+
55+
```js
56+
57+
58+
59+
```
60+
61+
</details>
62+
63+
## URL for which `sonar` failed
64+
65+
* __URL:__
66+
67+
## Output
68+
69+
Please include the raw output generated by `sonar`, or if possible,
70+
the raw output from running `sonar` in debug mode: `sonar --debug <URL>`.
71+
72+
<details>
73+
<summary>sonar's raw output</summary>
74+
75+
<!-- Paste the raw output below: -->
76+
77+
```text
78+
79+
80+
81+
```
82+
83+
</details>

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!--
2+
3+
Read our pull request guide:
4+
https://sonarwhal.com/docs/developer-guide/contributing/pull-requests.html
5+
6+
For the following items put an "x" between the square brackets
7+
(i.e. [x]) if you completed the associated item.
8+
9+
-->
10+
11+
## Pull request checklist
12+
13+
Make sure you:
14+
15+
- [ ] Signed the [Contributor License Agreement](https://cla.js.foundation/sonarwhal/sonar)
16+
- [ ] Followed the [commit message guidelines](https://sonarwhal.com/docs/developer-guide/contributing/pull-requests.html#commitmessages)
17+
18+
For non-trivial changes, please make sure you also:
19+
20+
- [ ] Added/Updated related documentation.
21+
- [ ] Added/Updated related tests.
22+
23+
## Short description of the change(s)
24+
25+
<!--
26+
27+
If this is a non-trivial change, include information such as what
28+
benefits this change brings as well as possible drawbacks.
29+
30+
If this fixes an existing issue, include the relavant issue number(s).
31+
32+
Thank you for taking the time to open this PR!
33+
34+
-->

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@
173173
"commitmsg": "node scripts/check-commit-message.js",
174174
"lint": "npm-run-all lint:*",
175175
"lint:js": "eslint --ext md --ext ts --ignore-pattern dist .",
176-
"lint:md": "markdownlint ./.github docs",
176+
"lint:md": "markdownlint docs",
177177
"preparecommitmsg": "node scripts/prepare-commit-message.js",
178178
"prepublishOnly": "npm i && npm run build",
179179
"release": "npm run test && node dist/scripts/release.js",

0 commit comments

Comments
 (0)