-
Notifications
You must be signed in to change notification settings - Fork 40.8k
Add repo-specific CONTRIBUTING.md #518
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
58df2c0
Add contributing guide file
MaoShizhong 7ef1882
Remove 'Adding New Exercises' section from general README.md
MaoShizhong bc1a836
Use repo-specific contributing guide link
MaoShizhong 39169ed
Use lazy numbering for ordered list
MaoShizhong b4be1d8
Combine separate instruction sentence with instruction list
MaoShizhong 098f3f4
Add important reminder about approved issue before PR
MaoShizhong File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# The Odin Project JavaScript Exercises Contributing Guide | ||
|
||
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. | ||
|
||
This contributing guide assumes you have followed the instructions in our general contributing guide to fork and clone our JavaScript exercises repo. | ||
|
||
## Table of Contents | ||
|
||
- [How to Contribute](#how-to-contribute) | ||
- [Prerequisites](#prerequisites) | ||
- [Adding New Exercises](#adding-new-exercises) | ||
|
||
## How to Contribute | ||
|
||
### Prerequisites | ||
|
||
- Node v18.0.0 or higher | ||
- npm v8.5.5 or higher | ||
|
||
### Adding New Exercises | ||
|
||
> [!IMPORTANT] | ||
> Please do not open a pull request with a new exercise unless you have opened an issue in this repo with your proposal **and** it has been approved by a maintainer. | ||
|
||
If a maintainer has approved a new exercise to be added, the new exercise(s) must follow the same format as existing exercises. | ||
|
||
To generate a new exercise template, do the following: | ||
|
||
1. Be sure to run `npm install` at the root of the `javascript-exercises` directory to install the necessary dependencies. | ||
1. Run the command `npm run generate`. | ||
1. When prompted, enter the name of the new exercise in "camelCase" syntax. This will create a new directory with the necessary files included. | ||
1. Update the `README.md` and `.spec.js` file, as well as the files inside the `solution` directory of the new exercise. | ||
1. Open a pull request with the new exercise. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.