8000 Add contributing guide file · Arzivak/javascript-exercises@58df2c0 · GitHub
[go: up one dir, main page]

Skip to content

Commit 58df2c0

Browse files
committed
Add contributing guide file
1 parent 203fd76 commit 58df2c0

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# The Odin Project JavaScript Exercises Contributing Guide
2+
3+
Thank you for expressing interest in contributing to The Odin Project (TOP) JavaScript exercises! Before continuing through this guide, be sure you've read our [general contributing guide](https://github.com/TheOdinProject/.github/blob/main/CONTRIBUTING.md), as it contains information that is important for all of our repos.
4+
5+
This contributing guide assumes you have followed the instructions in our general contributing guide to fork and clone our JavaScript exercises repo.
6+
7+
## Table of Contents
8+
9+
- [How to Contribute](#how-to-contribute)
10+
- [Prerequisites](#prerequisites)
11+
- [Adding New Exercises](#adding-new-exercises)
12+
13+
## How to Contribute
14+
15+
### Prerequisites
16+
17+
- Node v18.0.0 or higher
18+
- npm v8.5.5 or higher
19+
20+
### Adding New Exercises
21+
22+
If a maintainer has approved a new exercise to be added, the new exercise(s) must follow the same format as existing exercises.
23+
24+
To generate a new exercise template, do the following:
25+
26+
1. Be sure to run `npm install` at the root of the `javascript-exercises` directory to install the necessary dependencies.
4A70
27+
2. Run the command `npm run generate`.
28+
3. When prompted, enter the name of the new exercise in "camelCase" syntax.
29+
30+
After entering an exercise name, a new directory with the necessary files will be created. You will then need to update the `README.md` and `spec.js` files as well as the files in the `solution` directory of the new exercise.

0 commit comments

Comments
 (0)
0