-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Showing
2 changed files
with
51 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Pull Request | ||
|
||
<!-- | ||
The text in these markdown comments is instructions that will not appear in the displayed pull request, | ||
and can be deleted. | ||
Please submit pull requests against the develop branch. | ||
Follow the existing code style. Check the tests succeed, including lint. | ||
npm run test | ||
npm run lint | ||
Don't update the CHANGELOG or command version number. That gets done by maintainers when preparing the release. | ||
Commander currently has zero production dependencies. That isn't a hard requirement, but is a simple story. Requests which | ||
add a dependency are much less likely to be accepted, and we are likely to ask if there alternative approaches to avoid the dependency. | ||
--> | ||
|
||
## Problem | ||
|
||
<!-- | ||
What problem are you solving? | ||
What Issues does this relate to? | ||
Show the broken output if appropriate. | ||
--> | ||
|
||
## Solution | ||
|
||
<!-- | ||
How did you solve the problem? | ||
Show the fixed output if appropriate. | ||
There are a lot of forms of documentation which could need updating for a change in functionality. It | ||
is ok if you want to show us the code to discuss before doing the extra work, and | ||
you should say so in your comments so we focus on the concept first before talking about all the other pieces: | ||
- TypeScript typings | ||
- JSDoc documentation in code | ||
- tests | ||
- README | ||
- examples/ | ||
--> | ||
|
||
## ChangeLog | ||
|
||
<!-- | ||
Optional. Suggest a line for adding to the CHANGELOG to summarise your change. | ||
--> |
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