Skip to content

Commit 30ae1f7

Browse files
authored
docs: update the PR template (#1210)
1 parent 13399ea commit 30ae1f7

File tree

3 files changed

+36
-163
lines changed

3 files changed

+36
-163
lines changed

Diff for: .github/CONTRIBUTING.md

-151
This file was deleted.

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+33-9
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,37 @@
1+
<!--
12
We, the rest of the NativeScript community, thank you for your
2-
contribution! Because we want to present a really nice, readable changelog with each release, we ask you to provide the following information:
3+
contribution!
4+
To help the rest of the community review your change, please follow the instructions in the template.
5+
-->
36

4-
### Create a meaningful title
5-
Please, make sure your title is less than 50 characters wide and starts with a capital letter. We strive to follow the guidelines in the
6-
[How to Write a Git Commit Message] (http://chris.beams.io/posts/git-commit/) article for PR titles.
7+
<!-- PULL REQUEST TEMPLATE -->
8+
<!-- (Update "[ ]" to "[x]" to check a box) -->
79

8-
### Reference a specific issue in this repo
9-
Include the `Fixes/Implements #[Issue Number]` special wording.
10+
## PR Checklist
11+
12+
- [ ] The PR title follows our guidelines: https://github.com/NativeScript/NativeScript/blob/master/CONTRIBUTING.md#commit-messages.
13+
- [ ] There is an issue for the bug/feature this PR is for. To avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it.
14+
- [ ] You have signed the [CLA](http://www.nativescript.org/cla).
15+
- [ ] All existing tests are passing: https://github.com/NativeScript/nativescript-angular/blob/master/DevelopmentWorkflow.md#running-the-tests
16+
- [ ] Tests for the changes are included.
17+
18+
## What is the current behavior?
19+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
20+
21+
## What is the new behavior?
22+
<!-- Describe the changes. -->
23+
24+
Fixes/Implements/Closes #[Issue Number].
25+
26+
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
27+
28+
<!--
29+
BREAKING CHANGES:
30+
31+
32+
[Describe the impact of the changes here.]
33+
34+
Migration steps:
35+
[Provide a migration path for existing applications.]
36+
-->
1037

11-
### Add [tests](https://github.com/NativeScript/nativescript-angular/tests)
12-
If not added, tell us why?
13-
If not possible/feasible, please list all steps needed to manually test your pull request.

Diff for: DevelopmentWorkflow.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ $ tns run ios
4545

4646
## Running the tests
4747

48-
Install NPM packages (use the local copy of `nativescript-angular`):
48+
Install the NPM dependencies (use the local copy of `nativescript-angular`):
4949
```
5050
$ cd tests
5151
$ npm install
5252
```
5353

54-
Start test run:
54+
Run the tests:
5555

5656
```
5757
$ tns test ios
@@ -93,4 +93,4 @@ NOTE: The steps below describe how to run `renderer` tests, but the same approac
9393
## Developer workflow
9494

9595
1. Make changes to the `test`, `ng-sample` projects or in `nativescript-angular` folder.
96-
2. Run the `tests` or `ng-sample` as shown above.
96+
2. Run the `tests` or `ng-sample` as shown above.

0 commit comments

Comments
 (0)