Skip to content

Commit 440f749

Browse files
committed
adding prereqs to readme
1 parent d4f359c commit 440f749

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

Diff for: README.md

+14
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,25 @@ This repository contains the documentation website code and source files for htt
1111

1212
In this article, find information about:
1313

14+
- Prerequisites
1415
- Contributing
1516
- A list of READMEs
1617
- Code of conduct
1718
- License agreement
1819

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+
1933
## Contributing
2034

2135
The Segment docs team accepts contributions in the form of issues and pull requests.

0 commit comments

Comments
 (0)