Skip to content

Commit e16f6e5

Browse files
authored
Merge branch 'master' into travis_improvement
2 parents 72fc731 + 6f20eb6 commit e16f6e5

File tree

9 files changed

+672
-68
lines changed

9 files changed

+672
-68
lines changed

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Use LF for shell scripts
2+
*.sh eol=lf

.github/ISSUE_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PSST! Want to get faster responses to bug reports and important issues? Help us keep the issue tracker organized by:
22

3-
- Reporting bugs. Please include all details about the problem and provide a sample app.
3+
- Reporting bugs. Please include all details about the problem and provide a sample app (consider using the [playground](https://play.nativescript.org) for this.
44
- Proposing features and enhancements.
55
- Discussing implementation details.
66

7-
Please move all other content to [Stack Overflow](http://stackoverflow.com/questions/tagged/nativescript).
7+
Please move all other content to the [forums](http://forum.nativescript.org).

CODE_OF_CONDUCT.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# NativeScript Community Code of Conduct
2+
3+
Our community members come from all walks of life and are all at different stages of their personal and professional journeys. To support everyone, we've prepared a short code of conduct. Our mission is best served in an environment that is friendly, safe, and accepting; free from intimidation or harassment.
4+
5+
Towards this end, certain behaviors and practices will not be tolerated.
6+
7+
## tl;dr
8+
9+
- Be respectful.
10+
- We're here to help.
11+
- Abusive behavior is never tolerated.
12+
- Violations of this code may result in swift and permanent expulsion from the NativeScript community channels.
13+
14+
## Administrators
15+
16+
- Dan Wilson (@DanWilson on Slack)
17+
- Jen Looper (@jen.looper on Slack)
18+
- TJ VanToll (@tjvantoll on Slack)
19+
20+
## Scope
21+
22+
We expect all members of the NativeScript community, including administrators, users, facilitators, and vendors to abide by this Code of Conduct at all times in our community venues, online and in person, and in one-on-one communications pertaining to NativeScript affairs.
23+
24+
This policy covers the usage of the NativeScript Slack community, as well as the NativeScript support forums, NativeScript GitHub repositories, the NativeScript website, and any NativeScript-related events. This Code of Conduct is in addition to, and does not in any way nullify or invalidate, any other terms or conditions related to use of NativeScript.
25+
26+
The definitions of various subjective terms such as "discriminatory", "hateful", or "confusing" will be decided at the sole discretion of the NativeScript administrators.
27+
28+
## Friendly, Harassment-Free Space
29+
30+
We are committed to providing a friendly, safe, and welcoming environment for all, regardless of gender identity, sexual orientation, disability, ethnicity, religion, age, physical appearance, body size, race, or similar personal characteristics.
31+
32+
We ask that you please respect that people have differences of opinion regarding technical choices, and acknowledge that every design or implementation choice carries a trade-off and numerous costs. There is seldom a single right answer. A difference of technology preferences is never a license to be rude.
33+
34+
Any spamming, trolling, flaming, baiting, or other attention-stealing behaviour is not welcome, and will not be tolerated.
35+
36+
Harassing other users of NativeScript is never tolerated, whether via public or private media.
37+
38+
Avoid using offensive or harassing package names, nicknames, or other identifiers that might detract from a friendly, safe, and welcoming environment for all.
39+
40+
Harassment includes, but is not limited to: harmful or prejudicial verbal or written comments related to gender identity, sexual orientation, disability, ethnicity, religion, age, physical appearance, body size, race, or similar personal characteristics; inappropriate use of nudity, sexual images, and/or sexually explicit language in public spaces; threats of physical or non-physical harm; deliberate intimidation, stalking or following; harassing photography or recording; sustained disruption of talks or other events; inappropriate physical contact; and unwelcome sexual attention.
41+
42+
## Acceptable Content
43+
44+
The NativeScript administrators reserve the right to make judgement calls about what is and isn't appropriate in published content. These are guidelines to help you be successful in our community.
45+
46+
Content must contain something applicable to the previously stated goals of the NativeScript community. "Spamming", that is, publishing any form of content that is not applicable, is not allowed.
47+
48+
Content must not contain illegal or infringing content. You should only publish content to NativeScript properties if you have the right to do so. This includes complying with all software license agreements or other intellectual property restrictions. For example, redistributing an MIT-licensed module with the copyright notice removed, would not be allowed. You will be responsible for any violation of laws or others’ intellectual property rights.
49+
50+
Content must not be malware. For example, content (code, video, pictures, words, etc.) which is designed to maliciously exploit or damage computer systems, is not allowed.
51+
52+
Content name, description, and other visible metadata must not include abusive, inappropriate, or harassing content.
53+
54+
## Reporting Violations of this Code of Conduct
55+
56+
If you believe someone is harassing you or has otherwise violated this Code of Conduct, please contact the administrators and send us an abuse report. If this is the initial report of a problem, please include as much detail as possible. It is easiest for us to address issues when we have more context.
57+
58+
## Consequences
59+
60+
All content published to the NativeScript community channels is hosted at the sole discretion of the NativeScript administrators.
61+
62+
Unacceptable behavior from any community member, including sponsors, employees, customers, or others with decision-making authority, will not be tolerated.
63+
64+
Anyone asked to stop unacceptable behavior is expected to comply immediately.
65+
66+
If a community member engages in unacceptable behavior, the NativeScript administrators may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event or service).
67+
68+
## Addressing Grievances
69+
70+
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the administrators. We will do our best to ensure that your grievance is handled appropriately.
71+
72+
In general, we will choose the course of action that we judge as being most in the interest of fostering a safe and friendly community.
73+
74+
## Contact Info
75+
Please contact Dan Wilson @DanWilson if you need to report a problem or address a grievance related to an abuse report.
76+
77+
You are also encouraged to contact us if you are curious about something that might be "on the line" between appropriate and inappropriate content. We are happy to provide guidance to help you be a successful part of our community.
78+
79+
## Credit and License
80+
81+
This Code of Conduct borrows heavily from the WADE Code of Conduct, which is derived from the NodeBots Code of Conduct, which in turn borrows from the npm Code of Conduct, which was derived from the Stumptown Syndicate Citizen's Code of Conduct, and the Rust Project Code of Conduct.
82+
83+
This document may be reused under a Creative Commons Attribution-ShareAlike License.

CONTRIBUTING.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing to NativeScript Angular
2+
3+
:+1: First of all, thank you for taking the time to contribute! :+1:
4+
5+
Here are some guides on how to do that:
6+
7+
<!-- TOC depthFrom:2 -->
8+
9+
- [Code of Conduct](#code-of-conduct)
10+
- [Reporting Bugs](#reporting-bugs)
11+
- [Requesting Features](#requesting-features)
12+
- [Submitting a PR](#submitting-a-pr)
13+
- [Where to Start](#where-to-start)
14+
15+
<!-- /TOC -->
16+
17+
## Code of Conduct
18+
Help us keep a healthy and open community. We expect all participants in this project to adhere to the [NativeScript Code Of Conduct](https://github.com/NativeScript/codeofconduct).
19+
20+
21+
## Reporting Bugs
22+
23+
1. Always update to the most recent master release; the bug may already be resolved.
24+
2. Search for similar issues in the issues list for this repo; it may already be an identified problem.
25+
3. If this is a bug or problem that is clear, simple, and is unlikely to require any discussion -- it is OK to open an issue on GitHub with a reproduction of the bug including workflows and screenshots. If possible, submit a Pull Request with a failing test, entire application or module. If you'd rather take matters into your own hands, fix the bug yourself (jump down to the [Submitting a PR](#pr) section).
26+
27+
## Requesting Features
28+
29+
1. Use Github Issues to submit feature requests.
30+
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.
31+
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.
32+
33+
## Submitting a PR
34+
35+
Before you begin:
36+
* Read and sign the [NativeScript Contribution License Agreement](http://www.nativescript.org/cla).
37+
* Make sure there is an issue for the bug or feature you will be working on.
38+
39+
Following these steps is the best way to get you code included in the project:
40+
41+
1. Fork and clone the nativescript-angular repo:
42+
```bash
43+
git clone https://github.com/<your-git-username>/nativescript-angular.git
44+
# Navigate to the newly cloned directory
45+
cd nativescript-angular
46+
# Add an "upstream" remote pointing to the original repo.
47+
git remote add upstream https://github.com/NativeScript/nativescript-angular.git
48+
```
49+
50+
2. Read our [development workflow guide](DevelopmentWorkflow.md) for local setup:
51+
52+
3. Create a branch for your PR
53+
```bash
54+
git checkout -b <my-fix-branch> master
55+
```
56+
57+
4. The fun part! Make your code changes. Make sure you:
58+
- Follow the [code conventions guide](https://github.com/NativeScript/NativeScript/blob/master/CodingConvention.md).
59+
- Write unit tests for your fix or feature.
60+
61+
5. Before you submit your PR:
62+
- Rebase your changes to the latest master: `git pull --rebase upstream master`.
63+
- Ensure all unit test are green. Check [running unit tests](DevelopmentWorkflow.md#running-the-tests).
64+
- Ensure your changes pass tslint validation. (run `npm run tslint` in the root of the repo).
65+
66+
6. Push your fork. If you have rebased you might have to use force-push your branch:
67+
```
68+
git push origin <my-fix-branch> --force
69+
```
70+
71+
7. [Submit your pull request](https://github.com/NativeScript/nativescript-angular/compare). Please, fill in the Pull Request template - it will help us better understand the PR and increase the chances of it getting merged quickly.
72+
73+
It's our turn from there on! We will review the PR and discuss changes you might have to make before merging it! Thanks!
74+
75+
76+
## Where to Start
77+
78+
If you want to contribute, but you are not sure where to start - look for [issues labeled `help wanted`](https://github.com/NativeScript/nativescript-angular/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).

DevelopmentWorkflow.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Development Workflow
2+
3+
<!-- TOC depthFrom:2 -->
4+
5+
- [Running locally](#running-locally)
6+
- [Prerequisites](#prerequisites)
7+
- [Install dependencies](#install-dependencies)
8+
- [Run the sample application (ng-sample)](#run-the-sample-application-ng-sample)
9+
- [Running the tests](#running-the-tests)
10+
- [Testing locally by running e2e tests](#testing-locally-by-running-e2e-tests)
11+
- [Developer workflow](#developer-workflow)
12+
13+
<!-- /TOC -->
14+
15+
## Running locally
16+
17+
### Prerequisites
18+
19+
Install your native toolchain and NativeScript as described in the docs:
20+
21+
https://docs.nativescript.org/setup/quick-setup
22+
23+
24+
### Install dependencies
25+
26+
```
27+
$ cd nativescript-angular
28+
$ npm install
29+
```
30+
31+
### Run the sample application (ng-sample)
32+
33+
Install NPM packages (use the local copy of `nativescript-angular`):
34+
```
35+
$ cd ng-sample
36+
$ npm install
37+
```
38+
39+
Start the app:
40+
41+
```
42+
$ tns run android
43+
$ tns run ios
44+
```
45+
46+
## Running the tests
47+
48+
Install NPM packages (use the local copy of `nativescript-angular`):
49+
```
50+
$ cd tests
51+
$ npm install
52+
```
53+
54+
Start test run:
55+
56+
```
57+
$ tns test ios
58+
$ tns test android
59+
```
60+
61+
## Testing locally by running e2e tests
62+
63+
NOTE: The steps below describe how to run `renderer` tests, but the same approach can be used to run `router` or any other `e2e` tests.
64+
65+
1. Navigate to `e2e/renderer`
66+
``` bash
67+
cd e2e/renderer
68+
```
69+
70+
2. Install dependencies. This also installs your local copy of the nativescript-angular plugin.
71+
``` bash
72+
npm install
73+
```
74+
3. Make sure to have an emulator set up or connect a physical Android/iOS device.
75+
76+
4. Build the app for Android or iOS
77+
```bash
78+
tns run android/ios
79+
```
80+
81+
5. Install [appium](http://appium.io/) globally.
82+
``` bash
83+
npm install -g appium
84+
```
85+
86+
6. Follow the instructions in the [nativescript-dev-appium](https://github.com/nativescript/nativescript-dev-appium#custom-appium-capabilities) plugin to add an appium capability for your device inside `./e2e/renderer/e2e/config/appium.capabilities.json`.
87+
88+
7. Run the automated tests. The value of the `runType` argument should match the name of the capability that you just added.
89+
``` bash
90+
npm run e2e -- --runType capabilityName
91+
```
92+
93+
## Developer workflow
94+
95+
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.

0 commit comments

Comments
 (0)