diff --git a/README.md b/README.md index 90d977bf6..2e3b6ae9a 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,24 @@

-[![Build Status](https://travis-ci.org/NativeScript/NativeScript.svg?branch=master)](https://travis-ci.org/NativeScript/NativeScript) +
+ +![Automated Tests Passing](https://github.com/NativeScript/NativeScript/actions/workflows/apps_automated.yml/badge.svg) +[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/NativeScript/NativeScript/blob/master/LICENSE) +[![NPM Version](https://badge.fury.io/js/%40nativescript%2Fcore.svg)](https://www.npmjs.com/@nativescript/core) +[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://nativescript.org/discord) + +
-[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. - -## Setup and Installation - -* [Environment Setup](https://docs.nativescript.org/environment-setup.html) +[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. ## Contribute +1. [Setup your local development environment](https://docs.nativescript.org/environment-setup.html) + +2. Clone to contribute: + ```bash $ git clone https://github.com/NativeScript/NativeScript.git $ cd NativeScript @@ -26,7 +33,7 @@ $ npm run setup $ npm start ``` -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. +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. ## @nativescript/* @@ -47,27 +54,30 @@ We love you and your PR's 🤗. Please follow our [contributing guide](https://g ## Quick Links -- [NativeScript home page](https://nativescript.org) -- [NativeScript playground](https://play.nativescript.org) -- [NativeScript and Angular](https://play.nativescript.org/?template=play-ng&tutorial=getting-started-ng) -- [NativeScript on Twitter](http://twitter.com/NativeScript) -- [NativeScript on Stack Overflow](http://stackoverflow.com/questions/tagged/nativescript) +- [NativeScript Home](https://nativescript.org) +- [NativeScript Tutorials](https://docs.nativescript.org/tutorial/) - [NativeScript documentation](https://docs.nativescript.org/) +- JavaScript starter: https://nativescript.new/javascript +- TypeScript starter: https://nativescript.new/typescript +- Angular starter: https://nativescript.new/angular +- Vue starter: https://nativescript.new/vue +- Svelte starter: https://nativescript.new/svelte +- React starter: https://nativescript.new/react +- [NativeScript on Twitter](http://twitter.com/NativeScript) +- [NativeScript on Discord](https://nativescript.org/discord) +- [NativeScript on Stack Overflow](http://stackoverflow.com/questions/tagged/nativescript) ## Other source repos Outside the source centralized in this repo, NativeScript consists of a few other source repos. Here are the major ones: -- **[iOS runtime](https://github.com/NativeScript/ns-v8ios-runtime)** - - 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. -- **[Android runtime](https://github.com/NativeScript/android-runtime)** - - 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. +- **[iOS Runtime](https://github.com/NativeScript/ns-v8ios-runtime)** + - 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. +- **[Android Runtime](https://github.com/NativeScript/android-runtime)** + - 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. - **[CLI](//github.com/NativeScript/nativescript-cli)** - - 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. + - This repo contains the NativeScript command-line interface, which lets you create, build, and run apps using NativeScript. The CLI is written in TypeScript. - **[Docs](//github.com/NativeScript/docs-new)** - - This repo contains the NativeScript framework documentation, which is available at . The docs are written in Markdown. - -## License -[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/NativeScript/NativeScript/blob/master/LICENSE) + - This repo contains NativeScript documentation, which is available at . The docs are written in Markdown.

Made with ❤️

diff --git a/tools/notes/CONTRIBUTING.md b/tools/notes/CONTRIBUTING.md index 3453fbcbb..8339f34b4 100644 --- a/tools/notes/CONTRIBUTING.md +++ b/tools/notes/CONTRIBUTING.md @@ -17,7 +17,7 @@ Help us keep a healthy and open community. We expect all participants in this pr ## Reporting Bugs -1. Always update to the most recent master release; the bug may already be resolved. +1. Always update to the most recent [release](https://github.com/NativeScript/NativeScript/releases); the bug may already be resolved. 2. Search for similar issues in the issues list for this repo; it may already be an identified problem. 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). @@ -59,7 +59,7 @@ npm start 3. Create a branch for your PR ```bash -git checkout -b master +git checkout -b main ``` 4. The fun part! Make your code changes. Make sure you: @@ -68,10 +68,8 @@ git checkout -b master - Write unit tests for your fix or feature. Check out [writing unit tests guide](WritingUnitTests.md). 5. Before you submit your PR: - - Rebase your changes to the latest master: `git pull --rebase upstream master`. + - Rebase your changes to the latest main: `git pull --rebase upstream main`. - Ensure all unit test are green for Android and iOS. Check [running unit tests](DevelopmentWorkflow.md#running-unit-tests). - - Ensure your changes pass tslint validation. (run `npm run tslint` in the root of the repo). - - 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). 6. Push your fork. If you have rebased you might have to use force-push your branch: ```