Skip to content

Commit 22009e5

Browse files
molantmolant
authored
Docs: More contribution details
Fix #347
1 parent f0407e7 commit 22009e5

File tree

5 files changed

+155
-3
lines changed

5 files changed

+155
-3
lines changed

‎.github/CONTRIBUTING.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,27 @@
33
Please take a moment to review this document in order to make the
44
contribution process easy and effective for everyone involved.
55

6+
## Contributing code
7+
8+
Before doing any major changes, there are a couple things you should do:
9+
10+
1. Open an issue to discuss and potentially help if the team agrees
11+
the changes will be for the best.
12+
1. Familiarize yourself with the architecture and concepts by reading the
13+
[contributor guide][contributor guide] and the projects
14+
[pull request process][pr process].
15+
1. Sign our [Contributor License Agreement][cla]
16+
17+
We thank you for following these tips!
18+
619
## Code of Conduct
720

821
This project adheres to the [JS Foundation Code of
922
Conduct](https://js.foundation/community/code-of-conduct). We kindly
1023
request that you read over our code of conduct before contributing.
1124

12-
## Contributing Code
25+
<!-- Link labels -->
1326

14-
Please sign our [Contributor License Agreement](https://cla.js.foundation/webhintio/hint)
15-
and read the [Pull Request Guidelines](https://webhint.io/docs/contributor-guide/getting-started/pull-requests/).
27+
[cla]: https://cla.js.foundation/webhintio/hint
28+
[contributor guide]: https://webhint.io/docs/contributor-guide/
29+
[pr process]: https://webhint.io/docs/contributor-guide/getting-started/pull-requests/

‎.github/ISSUE_TEMPLATE/1-bug-report.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
name: "\U0001F41EBug report"
3+
about: Report a bug in webhint
4+
---
5+
<!--
6+
7+
Hi there 👋
8+
9+
Thanks for taking the time to make webhint better! Before
10+
opening a new issue please make sure to search in the existing
11+
ones (even closed!) as they might contain information about
12+
workarounds, resolution, or progress updates.
13+
14+
-->
15+
16+
# 🐛 Bug report
17+
18+
## Description
19+
20+
<!-- ✍️ What were you doing? How do we repro your issue? -->
21+
22+
## Environment
23+
24+
* __`hint` version:__ <!-- ✍️ Run `hint -v` -->
25+
* __`Node.js` version:__ <!-- ✍️ Run `node -v` -->
26+
* __`OS`:__ <!-- ✍️ -->
27+
* __URL for which webhint failed:__ <!-- ✍️ -->
28+
29+
## `webhint` configuration
30+
31+
<details>
32+
<summary>webhint’s configuration</summary>
33+
34+
```js
35+
<!-- Paste the content of your `.hintrc` here -->
36+
37+
```
38+
39+
</details>
40+
41+
## Debug output
42+
43+
Please include the raw output generated by `webhint`, or if possible,
44+
the raw output from running `webhint` in debug mode: `hint --debug <URL>`.
45+
46+
<details>
47+
<summary>webhint’s raw output</summary>
48+
49+
```text
50+
<!-- ✍️ Paste the raw output here -->
51+
52+
53+
```
54+
55+
</details>

‎.github/ISSUE_TEMPLATE/2-feature-request.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: "\U0001F680Feature request"
3+
about: Suggest a feature for webhint
4+
5+
---
6+
<!--
7+
8+
Hi there 👋
9+
10+
We're excited for your ideas about how to make webhint even better!
11+
Before opening a new issue please make sure to search in the existing
12+
ones (even closed!) as they might contain information about workarounds,
13+
resolution, or progress updates.
14+
15+
-->
16+
17+
# 🚀 Feature request
18+
19+
## Description
20+
21+
<!-- ✍️ --> What do you want to be added?
22+
23+
<!-- 💪 --> Are you willing to work on this?
24+
25+
## What scenarios will this solve?
26+
27+
<!-- ✍️ --> Why do you want/need this?

‎.github/ISSUE_TEMPLATE/3-docs-bug.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: "📚 Docs issue"
3+
about: Report an issue in webhint's documentation
4+
5+
---
6+
<!--
7+
8+
Hi there 👋
9+
10+
We're excited for your feedback to imoprove webhint's documentation!
11+
Before opening a new issue please make sure to search in the existing
12+
ones (even closed!) as they might contain information about workarounds,
13+
resolution, or progress updates.
14+
15+
-->
16+
17+
18+
# 📚 Docs issue
19+
20+
* **Affected URL**: <!-- ✍️ edit:--> https://webhint.io/docs/...
21+
* **What's the problem**: <!-- ✍️ edit:--> Is the content wrong or is there something broken like a link?

‎.github/ISSUE_TEMPLATE/4-new-hint-request.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: "\U0001F4A1Hint request"
3+
about: Suggest a new hint for webhint
4+
5+
---
6+
<!--
7+
8+
Hi there 👋
9+
10+
We're excited for your ideas about new things to test and make the web
11+
even better!
12+
Before opening a new issue please make sure to search in the existing
13+
ones (even closed!) as they might contain information about workarounds,
14+
resolution, or progress updates.
15+
16+
-->
17+
18+
# 🚀 Hint request
19+
20+
## Description
21+
22+
<!-- ✍️ --> What do you want webhint to test?
23+
24+
<!-- 💪 --> Are you willing to work on this?
25+
26+
## What should be tested exactly?
27+
28+
<!-- ✍️ --> Explain what and how things should be tested. If you don't know,
29+
don't worry and leave this empty.
30+
31+
32+
## Relevant links
33+
34+
<!-- ✍️ --> Any links to documentation, discussions, etc. relevant to the
35+
proposed hint that motivated you to open this issue.

0 commit comments

Comments
 (0)