Skip to content
This repository was archived by the owner on Aug 7, 2021. It is now read-only.

Commit 0bb673a

Browse files
radevasis0k0
radeva
authored andcommitted
chore: update readme and contributing guide (#434)
1 parent 0120329 commit 0bb673a

File tree

2 files changed

+46
-9
lines changed

2 files changed

+46
-9
lines changed

Diff for: CONTRIBUTING.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
1-
Contributing
1+
# Contributing
22
====================
33

4+
<!-- TOC depthFrom:2 -->
5+
6+
- [Introduction](#introduction)
7+
- [Project Structure](#project-structure)
8+
- [Setup](#setup)
9+
- [Testing locally](#testing-locally)
10+
- [Reporting Bugs](#reporting-bugs)
11+
- [Requesting Features](#requesting-features)
12+
- [Submitting PR](#submitting-pr)
13+
14+
<!-- /TOC -->
15+
416
## Introduction
517

618
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.
6779
6880
1. Always update to the most recent master release; the bug may already be resolved.
6981
2. Search for similar issues in the issues list for this repo; it may already be an identified problem.
70-
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).
82+
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).
7183

7284
## Requesting Features
7385

@@ -77,7 +89,7 @@ There are three apps in the repository, located in the `/demo` directory.
7789

7890
## Submitting PR
7991

80-
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).
92+
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).
8193

8294
2. Push your branch to GitHub:
8395
```bash

Diff for: README.md

+31-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,34 @@
1-
# nativescript-dev-webpack
1+
# NativeScript Webpack
22

3-
A package to help with webpacking NativeScript apps.
3+
This repository contains the code for the nativescript-dev-webpack plugin which helps in webpacking [NativeScript](https://www.nativescript.org/) apps.
44

5-
# Ingredients
5+
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.
6+
7+
Why bundle scripts in a mobile app though?
8+
9+
- Fewer filesystem operations on app startup
10+
- Smaller code size
11+
- Tree-shaking
12+
- 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
13+
14+
For more details, see the [NativeScript docs for building with webpack](http://docs.nativescript.org/angular/best-practices/bundling-with-webpack.html).
15+
16+
<!-- TOC depthFrom:2 -->
17+
18+
- [Ingredients](#ingredients)
19+
- [Usage](#usage)
20+
- [Contribute](#contribute)
21+
- [Get Help](#get-help)
22+
23+
<!-- /TOC -->
24+
25+
## Ingredients
626

727
* webpack config templates.
828
* helper functions that place files at the correct locations before packaging apps.
929
* loaders and plugins for vanilla NativeScript and Angular apps.
1030

11-
# Usage
31+
## Usage
1232

1333
```sh
1434
$ npm install --save-dev nativescript-dev-webpack
@@ -18,7 +38,12 @@ or
1838
$ tns run ios --bundle
1939
```
2040

21-
# Documentation
41+
## Contribute
42+
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).
43+
44+
## Get Help
45+
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).
46+
47+
![](https://ga-beacon.appspot.com/UA-111455-24/nativescript/nativescript-dev-webpack?pixel)
2248

23-
For details, see the [NativeScript docs](http://docs.nativescript.org/angular/best-practices/bundling-with-webpack.html).
2449

0 commit comments

Comments
 (0)