-
-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
477353e
commit 3b01171
Showing
1 changed file
with
18 additions
and
17 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# Contributing | ||
|
||
:+1::tada: First off, thanks for taking the time to contribute to `nvm`! :tada::+1: | ||
:+1::tada: First off thanks for taking the time to contribute to `nvm`! :tada::+1: | ||
|
||
We love pull requests and issues, they're our favorite. | ||
|
||
|
@@ -20,13 +20,13 @@ You can consider helping out with issues already requiring attention - look for | |
|
||
Explain the problem and include additional details to help maintainers reproduce the problem: | ||
|
||
* **Use a clear and descriptive title** for the issue to identify the problem. | ||
- **Use a clear and descriptive title** for the issue to identify the problem. | ||
|
||
* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining which command exactly you used in the terminal. When listing steps, **don't just say what you did, but explain how you did it**. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or a command, and if so which one? | ||
* **Provide specific examples to demonstrate the steps**. Include links to files or Github projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). | ||
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. | ||
* **Explain which behavior you expected to see instead and why.** | ||
* **Provide as much context as possible** in order to help others verify and ultimately fix the issue. This includes giving us as much details as possible about your environment, so we can more easily confirm the problem. | ||
- **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining which command exactly you used in the terminal. When listing steps, **don't just say what you did, but explain how you did it**. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or a command, and if so which one? | ||
- **Provide specific examples to demonstrate the steps**. Include links to files or Github projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). | ||
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. | ||
- **Explain which behavior you expected to see instead and why.** | ||
- **Provide as much context as possible** in order to help others verify and ultimately fix the issue. This includes giving us as much details as possible about your environment, so we can more easily confirm the problem. | ||
|
||
## Documentation | ||
|
||
|
@@ -42,10 +42,10 @@ Please refer to the [README](README.md) for complete instructions how to install | |
|
||
#### Before creating a pull request | ||
|
||
- Please include tests. Changes with tests will be merged very quickly. | ||
- Please manually confirm that your changes work in `bash`, `sh`/`dash`, `ksh`, and `zsh`. Fast tests do run in these shells, but it's nice to manually verify also. | ||
- Please maintain consistent whitespace - 2-space indentation, trailing newlines in all files, etc. | ||
- Any time you make a change to your PR, please rebase freshly on top of the default branch. Nobody likes merge commits. | ||
- Please include tests. Changes with tests will be merged very quickly. | ||
- Please manually confirm that your changes work in `bash`, `sh`/`dash`, `ksh`, and `zsh`. Fast tests do run in these shells, but it's nice to manually verify also. | ||
- Please maintain consistent whitespace - 2-space indentation, trailing newlines in all files, etc. | ||
- Any time you make a change to your PR, please rebase freshly on top of the default branch. Nobody likes merge commits. | ||
|
||
Even if you don't have all of these items covered, please still feel free to submit a PR/issue! Someone else may be inspired and volunteer to complete it for you. | ||
|
||
|
@@ -86,10 +86,10 @@ Send the [pull request](https://docs.github.com/en/pull-requests), make requeste | |
|
||
### Commit Messages | ||
|
||
* Limit the first line of the commit message (message summary) to 72 characters or less. | ||
* Use the present tense ("Add feature" not "Added feature") and imperative mood ("Move cursor to..." not "Moves cursor to...") when providing a description of what you did. | ||
* If your PR addresses an issue, reference it in the body of the commit message. | ||
* See the rest of the conventions [here](https://gist.github.com/ljharb/772b0334387a4bee89af24183114b3c7) | ||
- Limit the first line of the commit message (message summary) to 72 characters or less. | ||
- Use the present tense ("Add feature" not "Added feature") and imperative mood ("Move cursor to..." not "Moves cursor to...") when providing a description of what you did. | ||
- If your PR addresses an issue, reference it in the body of the commit message. | ||
- See the rest of the conventions [here](https://gist.github.com/ljharb/772b0334387a4bee89af24183114b3c7) | ||
|
||
#### Commit message example | ||
|
||
|
@@ -101,15 +101,16 @@ Longer description here if necessary | |
Fixes #1234 | ||
``` | ||
|
||
> **Note:** Add co-authors to your commit message for commits with multiple authors | ||
> **Note:** Add co-authors to your commit message for commits with multiple authors | ||
``` | ||
Co-authored-by: Name Here <email@here> | ||
``` | ||
|
||
|
||
# Code of Conduct | ||
|
||
[Code of Conduct](https://github.com/nvm-sh/nvm/blob/HEAD/CODE_OF_CONDUCT.md) | ||
|
||
# Where can I ask for help? | ||
|
||
If you have any questions, please contact [@LJHarb](mailto:[email protected]). |