-
Notifications
You must be signed in to change notification settings - Fork 12
/
index.html
83 lines (67 loc) · 4.4 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Getting Started with Node.js Core Development</title>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/3.0.3/normalize.min.css" type="text/css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Baloo+Tamma%7COpen+Sans">
<link rel="stylesheet" href="style.css" type="text/css">
<meta property="og:title" content="Getting Started with Node.js Core Development">
<meta property="og:description" content="Getting started contributing to Node.js.">
<meta property="og:type" content="website">
<meta property="og:url" content="http://nodetodo.org/">
</head>
<body>
<header>
<section>
<h1><a href="..">Node.js Core Development</a></h1>
</section>
</header>
<main>
<section>
<h2>Getting Started</h2>
<ul class="instructions">
<li>You will need <code>git</code>. If you do not have it installed, <a href="https://git-scm.com/downloads">download it</a> and install it. (Windows users should select <a href="./zgitinstall.png">the option to use Unix tools from the command line</a>.)</li>
<li>If you don't already have one, <a href="https://github.com/join">create a GitHub account</a>.</li>
<li>Open the <a href="https://github.com/nodejs/node">Node.js core repository web page</a>.</li>
<li>Use the "Fork" button to fork the repository:
<img src="zfork.png" alt="" style="max-width:100%;">
</li>
<li>On the page <em>for your own fork</em>, use the "Code" button and copy the URL for cloning to your clipboard:
<img src="zclone.png" alt="" style="max-width:100%;">
</li>
<li>
Recommendation: Use the <code>SSH</code> URL within the "Code" modal. Username and password authentication via <code>HTTPS</code> is <a href="https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/">no longer supported</a>, and you won't notice until you try to commit your local code back to the fork. Refer to the <a href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh">SSH documentation on GitHub</a> if you need help setting this up.
</li>
<li>On the command line, in your home directory or a directory you have for projects, run:
<blockquote><code>git clone <paste that URL here!></code></blockquote>
</li>
<li>When that is done:
<blockquote><code>cd node</code></blockquote>
</li>
<li>Then (if using <code>SSH</code> as recommended):
<blockquote><code>git remote add upstream git@github.com:nodejs/node.git</code></blockquote>
</li>
<li>Optional, but recommended: Configure `git` so that it knows who
you are:
<blockquote><code>git config user.name "<Your Name Here!>"</code></blockquote>
<blockquote><code>git config user.email "<Your Email Address Here!>"</code></blockquote>
Make sure your email address is also added to your
<a href="https://github.com/settings/emails">GitHub email list</a>
so that your commits will be properly associated with your account
and you will be promoted to Contributor once your first commit is
landed!
</li>
<li>Follow <a href="https://github.com/nodejs/node/blob/main/BUILDING.md">the instructions to build Node.js</a>. You should not install the version of Node.js built with these instructions. Follow the instructions to build and test only. Once you have <code>make test</code> or <code>vcbuild test</code> running successfully, you are ready to start contributing.</li>
<li>If all your tests passed, you can look at the <a href="next-steps/">Next Steps</a> page for suggestions on ways to find issues to work on. If you have tests that are failing, try to figure out why that is. If you need help, search/use the <a href="https://github.com/nodejs/node/issues">Node.js issue tracker</a>.</li>
</ul>
</section>
</main>
<footer>
<section>
This website is open source and you can fork it <a href="https://github.com/Trott/nodetodo">on GitHub</a>.
</section>
</footer>
</body>
</html>