Skip to content

Commit 54994eb

Browse files
committed
feat(website): document how to submit a patch
1 parent 7f31d31 commit 54994eb

File tree

2 files changed

+95
-1
lines changed

2 files changed

+95
-1
lines changed

website/public/contribute/index.mjs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,12 @@ let __dirname = path.dirname(__filename);
1111

1212
export async function loadNavSubpagesAsync() {
1313
let root = path.join(__dirname, "..");
14-
let subpages = ["build-from-source", "create-diagnostic", "coding-standards"];
14+
let subpages = [
15+
"build-from-source",
16+
"create-diagnostic",
17+
"coding-standards",
18+
"submit",
19+
];
1520
return [].concat(
1621
...(await Promise.all(
1722
subpages.map(
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
<!---{
2+
"title": "Submitting patches",
3+
"navTitle": "Submitting"
4+
}--->
5+
6+
<!DOCTYPE html>
7+
<!-- Copyright (C) 2020 Matthew "strager" Glazar -->
8+
<!-- See end of file for extended copyright information. -->
9+
<html>
10+
<head>
11+
<%- await include("../../common-head.ejs.html") %>
12+
<link href="../../main.css" rel="stylesheet" />
13+
</head>
14+
<body class="side-bar-nav">
15+
<header><%- await include("../../common-nav.ejs.html") %></header>
16+
17+
<main>
18+
<h2><%= meta.title %></h2>
19+
20+
<p>
21+
Do you have an awesome change to quick-lint-js you want to contribute
22+
back to the maintainers? Let's get your patch out there!
23+
</p>
24+
25+
<h3>Pre-submit checklist</h3>
26+
27+
<ul>
28+
<li>Tests pass on your machine.</li>
29+
<li>
30+
Code adheres to the
31+
<a href="../coding-standards/">coding standards</a>.
32+
</li>
33+
<li>
34+
New automated tests are included. (Tests are only necessary bug fixes
35+
and features.)
36+
</li>
37+
<li>Documentation is updated, if appropriate.</li>
38+
<li>
39+
Code is checked into Git as one commit or a small number of commits.
40+
</li>
41+
<li>
42+
Commits have a description explaining what the problem was and what
43+
the solution is. The first line of the commit follows
44+
<a href="https://www.conventionalcommits.org/en/v1.0.0/"
45+
>Conventional Commits</a
46+
>. Use <kbd>git log</kbd> to see examples.
47+
</li>
48+
</ul>
49+
50+
<h3>Submitting the patch</h3>
51+
52+
<p>
53+
quick-lint-js maintainers prefer to receive a GitHub pull request with
54+
your patches. If you are new to using GitHub, check out freeCodeCamp's
55+
<a
56+
href="https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3/#let-s-make-our-first-pull-request-"
57+
>guide to creating your first pull request</a
58+
>.
59+
</p>
60+
61+
<p>
62+
If you prefer to submit your patch discretely, send an email to
63+
<a href="mailto:[email protected]">[email protected]</a>.
64+
</p>
65+
</main>
66+
67+
<footer><%- await include("../../common-footer-nav.ejs.html") %></footer>
68+
</body>
69+
</html>
70+
71+
<!--
72+
quick-lint-js finds bugs in JavaScript programs.
73+
Copyright (C) 2020 Matthew "strager" Glazar
74+
75+
This file is part of quick-lint-js.
76+
77+
quick-lint-js is free software: you can redistribute it and/or modify
78+
it under the terms of the GNU General Public License as published by
79+
the Free Software Foundation, either version 3 of the License, or
80+
(at your option) any later version.
81+
82+
quick-lint-js is distributed in the hope that it will be useful,
83+
but WITHOUT ANY WARRANTY; without even the implied warranty of
84+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
85+
GNU General Public License for more details.
86+
87+
You should have received a copy of the GNU General Public License
88+
along with quick-lint-js. If not, see <https://www.gnu.org/licenses/>.
89+
-->

0 commit comments

Comments
 (0)