FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

chore: markdown cleanup · TypescriptID/NativeScript@01ed588 · GitHub

/ NativeScript Public
forked from NativeScript/NativeScript

Commit 01ed588

Browse files
NathanWalker
committed
chore: markdown cleanup
1 parent 5206061 commit 01ed588

2 files changed

Lines changed: 31 additions & 23 deletions

File tree

‎README.md‎

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,24 @@
44
</a>
55
</p>
66

7-
[![Build Status](https://travis-ci.org/NativeScript/NativeScript.svg?branch=master)](https://travis-ci.org/NativeScript/NativeScript)
7+
<div style="text-align: center;">
88

9+
![Automated Tests Passing](https://github.com/NativeScript/NativeScript/actions/workflows/apps_automated.yml/badge.svg)
10+
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/NativeScript/NativeScript/blob/master/LICENSE)
11+
[![NPM Version](https://badge.fury.io/js/%40nativescript%2Fcore.svg)](https://www.npmjs.com/@nativescript/core)
12+
[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://nativescript.org/discord)
913

10-
[NativeScript](http://www.nativescript.org) empowers you to access native APIs from JavaScript directly. The framework currently provides iOS and Android runtimes for rich mobile development and can be utilized in a number of diverse use cases.
14+
</div>
1115

12-
## Setup and Installation
1316

14-
* [Environment Setup](https://docs.nativescript.org/environment-setup.html)
17+
[NativeScript](http://www.nativescript.org) empowers you to access native APIs from JavaScript directly. Currently iOS and Android runtimes are provided for rich mobile development across a variety of diverse use cases.
1518

1619
## Contribute
1720

21+
1. [Setup your local development environment](https://docs.nativescript.org/environment-setup.html)
22+
23+
2. Clone to contribute:
24+
1825
```bash
1926
$ git clone https://github.com/NativeScript/NativeScript.git
2027
$ cd NativeScript
@@ -26,7 +33,7 @@ $ npm run setup
2633
$ npm start
2734
```
2835

29-
We love you and your PR's 🤗. Please follow our [contributing guide](https://github.com/NativeScript/NativeScript/blob/master/tools/notes/CONTRIBUTING.md) and see [our code of governance](https://github.com/NativeScript/management/blob/master/nativescript-governance.md) to become as involved as you want to be.
36+
We love you and your pull requests 🤗. Please follow our [contributing guide](https://github.com/NativeScript/NativeScript/blob/master/tools/notes/CONTRIBUTING.md) and see [our code of governance](https://github.com/NativeScript/management/blob/master/nativescript-governance.md) to become as involved as you want to be.
3037

3138
## @nativescript/*
3239

@@ -47,27 +54,30 @@ We love you and your PR's 🤗. Please follow our [contributing guide](https://g
4754

4855
## Quick Links
4956

50-
- [NativeScript home page](https://nativescript.org)
51-
- [NativeScript playground](https://play.nativescript.org)
52-
- [NativeScript and Angular](https://play.nativescript.org/?template=play-ng&tutorial=getting-started-ng)
57+
- [NativeScript Home](https://nativescript.org)
58+
- [NativeScript Tutorials](https://docs.nativescript.org/tutorial/)
59+
- [NativeScript documentation](https://docs.nativescript.org/)
60+
- JavaScript starter: https://nativescript.new/javascript
61+
- TypeScript starter: https://nativescript.new/typescript
62+
- Angular starter: https://nativescript.new/angular
63+
- Vue starter: https://nativescript.new/vue
64+
- Svelte starter: https://nativescript.new/svelte
65+
- React starter: https://nativescript.new/react
5366
- [NativeScript on Twitter](http://twitter.com/NativeScript)
67+
- [NativeScript on Discord](https://nativescript.org/discord)
5468
- [NativeScript on Stack Overflow](http://stackoverflow.com/questions/tagged/nativescript)
55-
- [NativeScript documentation](https://docs.nativescript.org/)
5669

5770
## Other source repos
5871

5972
Outside the source centralized in this repo, NativeScript consists of a few other source repos. Here are the major ones:
6073

61-
- **[iOS runtime](https://github.com/NativeScript/ns-v8ios-runtime)**
62-
- This repo contains the NativeScript iOS runtime — the code that hosts NativeScript iOS apps, and allows JavaScript code to be executed on iOS devices. The iOS runtime is written in a fun mix of C++, Objective-C, and more.
63-
- **[Android runtime](https://github.com/NativeScript/android-runtime)**
64-
- This repo contains the NativeScript Android runtime — the code that hosts NativeScript Android apps, and allows JavaScript code to be executed on Android devices. The Android runtime is written in a fun mix of C++ and Java.
74+
- **[iOS Runtime](https://github.com/NativeScript/ns-v8ios-runtime)**
75+
- This repo contains the NativeScript iOS Runtime — the code that hosts NativeScript iOS apps, and allows JavaScript code to be executed on iOS devices. The iOS runtime is written in a mix of C++, Objective-C, and more.
76+
- **[Android Runtime](https://github.com/NativeScript/android-runtime)**
77+
- This repo contains the NativeScript Android Runtime — the code that hosts NativeScript Android apps, and allows JavaScript code to be executed on Android devices. The Android runtime is written in a mix of C++ and Java.
6578
- **[CLI](//github.com/NativeScript/nativescript-cli)**
66-
- This repo contains the NativeScript command-line interface, which lets you create, build, and run apps using the NativeScript framework. The CLI is written in TypeScript.
79+
- This repo contains the NativeScript command-line interface, which lets you create, build, and run apps using NativeScript. The CLI is written in TypeScript.
6780
- **[Docs](//github.com/NativeScript/docs-new)**
68-
- This repo contains the NativeScript framework documentation, which is available at <http://docs.nativescript.org/>. The docs are written in Markdown.
69-
70-
## License
71-
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/NativeScript/NativeScript/blob/master/LICENSE)
81+
- This repo contains NativeScript documentation, which is available at <http://docs.nativescript.org/>. The docs are written in Markdown.
7282

7383
<h3 align="center">Made with ❤️</h3>

‎tools/notes/CONTRIBUTING.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Help us keep a healthy and open community. We expect all participants in this pr
1717

1818
## <a name="bugs"></a> Reporting Bugs
1919

20-
1. Always update to the most recent master release; the bug may already be resolved.
20+
1. Always update to the most recent [release](https://github.com/NativeScript/NativeScript/releases); the bug may already be resolved.
2121
2. Search for similar issues in the issues list for this repo; it may already be an identified problem.
2222
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).
2323

@@ -59,7 +59,7 @@ npm start
5959

6060
3. Create a branch for your PR
6161
```bash
62-
git checkout -b <my-fix-branch> master
62+
git checkout -b <my-fix-branch> main
6363
```
6464

6565
4. The fun part! Make your code changes. Make sure you:
@@ -68,10 +68,8 @@ git checkout -b <my-fix-branch> master
6868
- Write unit tests for your fix or feature. Check out [writing unit tests guide](WritingUnitTests.md).
6969

7070
5. Before you submit your PR:
71-
- Rebase your changes to the latest master: `git pull --rebase upstream master`.
71+
- Rebase your changes to the latest main: `git pull --rebase upstream main`.
7272
- Ensure all unit test are green for Android and iOS. Check [running unit tests](DevelopmentWorkflow.md#running-unit-tests).
73-
- Ensure your changes pass tslint validation. (run `npm run tslint` in the root of the repo).
74-
- If you've made changes to a public API, make sure you update and add the `api-reports/NativeScript.api.md` file to the PR. (run `npm run api-extractor` to update the api-report and definitions).
7573

7674
6. Push your fork. If you have rebased you might have to use force-push your branch:
7775
```

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL