diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f421d12..fe564d2c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,18 @@ -Contributing +# Contributing ==================== + + +- [Introduction](#introduction) +- [Project Structure](#project-structure) +- [Setup](#setup) +- [Testing locally](#testing-locally) +- [Reporting Bugs](#reporting-bugs) +- [Requesting Features](#requesting-features) +- [Submitting PR](#submitting-pr) + + + ## Introduction First of all, thank you for taking the time to contribute! @@ -67,7 +79,7 @@ There are three apps in the repository, located in the `/demo` directory. 1. Always update to the most recent master release; 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). +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](#submitting-pr) section). ## Requesting Features @@ -77,7 +89,7 @@ There are three apps in the repository, located in the `/demo` directory. ## Submitting PR -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). +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). 2. Push your branch to GitHub: ```bash diff --git a/README.md b/README.md index 218bc978..12680cad 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,34 @@ -# nativescript-dev-webpack +# NativeScript Webpack -A package to help with webpacking NativeScript apps. +This repository contains the code for the nativescript-dev-webpack plugin which helps in webpacking [NativeScript](https://www.nativescript.org/) apps. -# Ingredients +JavaScript code and general asset bundling have been a member of the web developer toolbox for a long time. Tools like Webpack have been providing support for an enjoyable development experience that lets you assemble client-side code from various module sources and formats and then package it together. Most importantly, they allow for page load time optimizations that reduce or parallelize the number of requests a browser makes to the server. + +Why bundle scripts in a mobile app though? + +- Fewer filesystem operations on app startup +- Smaller code size +- Tree-shaking +- Preprocessing and interoperability hooks. Webpack provides a way to resolve modules and expressions differently according to its configuration. It also contains a lot of plugins and loaders that let you embed different content in your application or use code written in different programming languages + +For more details, see the [NativeScript docs for building with webpack](http://docs.nativescript.org/angular/best-practices/bundling-with-webpack.html). + + + +- [Ingredients](#ingredients) +- [Usage](#usage) +- [Contribute](#contribute) +- [Get Help](#get-help) + + + +## Ingredients * webpack config templates. * helper functions that place files at the correct locations before packaging apps. * loaders and plugins for vanilla NativeScript and Angular apps. -# Usage +## Usage ```sh $ npm install --save-dev nativescript-dev-webpack @@ -18,7 +38,12 @@ or $ tns run ios --bundle ``` -# Documentation +## Contribute +We love PRs! Check out the [contributing guidelines](CONTRIBUTING.md) and [instructions for local setup](https://github.com/NativeScript/nativescript-dev-webpack/blob/master/CONTRIBUTING.md#setup). If you want to contribute, but you are not sure where to start - look for [issues labeled `help wanted`](https://github.com/NativeScript/nativescript-dev-webpack/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). + +## Get Help +Please, use [github issues](https://github.com/NativeScript/nativescript-dev-webpack/issues) strictly for [reporting bugs](CONTRIBUTING.md#reporting-bugs) or [requesting features](CONTRIBUTING.md#requesting-features). For general questions and support, check out the [NativeScript community forum](https://discourse.nativescript.org/) or ask our experts in [NativeScript community Slack channel](http://developer.telerik.com/wp-login.php?action=slack-invitation). + +![](https://ga-beacon.appspot.com/UA-111455-24/nativescript/nativescript-dev-webpack?pixel) -For details, see the [NativeScript docs](http://docs.nativescript.org/angular/best-practices/bundling-with-webpack.html).