Skip to content

Commit 2a7420a

Browse files
authored
Merge pull request #182 from NativeScript/sis0k0/pr-template
docs: add a PR template and instructions for running the tests
2 parents fcb3a21 + dea337b commit 2a7420a

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!--
2+
We, the rest of the NativeScript community, thank you for your
3+
contribution!
4+
To help the rest of the community review your change, please follow the instructions in the template.
5+
-->
6+
7+
<!-- PULL REQUEST TEMPLATE -->
8+
<!-- (Update "[ ]" to "[x]" to check a box) -->
9+
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].
15+
- [ ] All existing tests are passing: https://github.com/NativeScript/nativescript-schematics/blob/master/CONTRIBUTING.md#running-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+
-->
37+
38+
39+
[CLA]: http://www.nativescript.org/cla

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,16 @@ You are good to go! You're strongly encouraged to follow the official NativeScri
4646
2. First, search for a similar request and extend it if applicable. This way it would be easier for the community to track the features.
4747
3. When requesting a new feature, please provide as much detail as possible about why you need the feature in your apps. We prefer that you explain a need rather than explain a technical solution for it. That might trigger a nice conversation on finding the best and broadest technical solution to a specific need.
4848

49+
## Running Tests
50+
51+
1. To run the unit tests, execute the following command in the root of the project:
52+
53+
```
54+
npm test
55+
```
56+
57+
2. The end-to-end (e2e) tests for this project are integrated within the internal build infrastructure for NativeScript. Because of that, they are not available for local execution. They will be executed internally when you submit a pull request.
58+
4959
## Submitting PR
5060

5161
1. Create one or several commits describing your changes. Follow the [Angular commit message guidelines](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w).

0 commit comments

Comments
 (0)