You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14
Original file line number
Diff line number
Diff line change
@@ -11,11 +11,25 @@ This repository contains the documentation website code and source files for htt
11
11
12
12
In this article, find information about:
13
13
14
+
- Prerequisites
14
15
- Contributing
15
16
- A list of READMEs
16
17
- Code of conduct
17
18
- License agreement
18
19
20
+
## Prerequisites
21
+
The following are a list of prerequisites you may want to consider downloading and installing to successfully contribute to the Segment docs repo:
22
+
23
+
1. Download and install a source code editor like [Visual Studio Code](https://code.visualstudio.com/download).
24
+
1. Download and install a package manager such as [Homebrew](https://brew.sh/) to install new software.
25
+
1.[Create an account on GitHub](https://docs.github.com/en/get-started/quickstart/creating-an-account-on-github) if you don't have one already, or sign in with your existing Github account.
26
+
1. Add the GitHub extension to your editor (in VSC: https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github)
27
+
1.[Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the segment docs repo.
28
+
1. Download and install the latest version of [node.js](https://nodejs.org/en/download). Consider using a version manager such as [ASDF](https://github.com/asdf-vm/asdf) or [nvm-windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows)
29
+
1. Install dependencies
30
+
`npm i`
31
+
1. Install [vale](https://docs.errata.ai/vale/install) (an [ASDF plugin](https://github.com/osg/asdf-vale) is also available).
32
+
19
33
## Contributing
20
34
21
35
The Segment docs team accepts contributions in the form of issues and pull requests.
0 commit comments