Skip to content

Commit d6da8d3

Browse files
author
radeva
authored
Merge pull request #69 from NativeScript/radeva/update-readme
docs: update readme and contributing guidelines
2 parents 2620d59 + 39426f1 commit d6da8d3

File tree

5 files changed

+195
-4
lines changed

5 files changed

+195
-4
lines changed

‎.github/issue_template.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
### Make sure to check the demo app(s) for sample usage
2+
3+
### Make sure to check the existing issues in this repository
4+
5+
### If the demo apps cannot help and there is no issue for your problem, tell us about it
6+
Please, ensure your title is less than 63 characters long and starts with a capital
7+
letter.
8+
9+
### Which platform(s) does your issue occur on?
10+
- iOS/Android/Both
11+
- iOS/Android versions
12+
- emulator or device. What type of device?
13+
14+
### Please, provide the following version numbers that your issue occurs with:
15+
16+
- CLI: (run `tns --version` to fetch it)
17+
- Cross-platform modules: (check the 'version' attribute in the
18+
`node_modules/tns-core-modules/package.json` file in your project)
19+
- Runtime(s): (look for the `"tns-android"` and `"tns-ios"` properties in the `package.json` file of your project)
20+
- Plugin(s): (look for the version numbers in the `package.json` file of your
21+
project and paste your dependencies and devDependencies here)
22+
23+
### Please, tell us how to recreate the issue in as much detail as possible.
24+
Describe the steps to reproduce it.
25+
26+
### Is there any code involved?
27+
- provide a code example to recreate the problem
28+
- (EVEN BETTER) provide a .zip with application or refer to a repository with application where the problem is reproducible.

‎.github/pull_request_template.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!--
2+
We, the rest of the NativeScript community, thank you for your
3+
contribution!
4+
To help the rest of the community review your change, please follow the instructions in the template.
5+
-->
6+
7+
<!-- PULL REQUEST TEMPLATE -->
8+
<!-- (Update "[ ]" to "[x]" to check a box) -->
9+
10+
## PR Checklist
11+
12+
- [ ] The PR title follows our guidelines: https://github.com/NativeScript/NativeScript/blob/master/CONTRIBUTING.md#commit-messages.
13+
- [ ] There is an issue for the bug/feature this PR is for. To avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it.
14+
- [ ] All existing tests are passing
15+
- [ ] Tests for the changes are included
16+
17+
## What is the current behavior?
18+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
19+
20+
## What is the new behavior?
21+
<!-- Describe the changes. -->
22+
23+
Fixes/Implements/Closes #[Issue Number].
24+
25+
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
26+
27+
<!--
28+
BREAKING CHANGES:
29+
30+
31+
[Describe the impact of the changes here.]
32+
33+
Migration steps:
34+
[Provide a migration path for existing applications.]
35+
-->
36+

‎CONTRIBUTING.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributing to NativeScript Dev Sass
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](#submitting-a-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 make sure there is an issue for the bug or feature you will be working on.
36+
37+
Following these steps is the best way to get your code included in the project:
38+
39+
1. Fork and clone the nativescript-dev-sass repo:
40+
```bash
41+
git clone https://github.com/<your-git-username>/nativescript-dev-sass.git
42+
# Navigate to the newly cloned directory
43+
cd nativescript-dev-sass
44+
# Add an "upstream" remote pointing to the original repo.
45+
git remote add upstream https://github.com/NativeScript/nativescript-dev-sass.git
46+
```
47+
48+
2. Read our [development workflow guide](DevelopmentWorkflow.md) for local setup
49+
50+
3. Create a branch for your PR
51+
```bash
52+
git checkout -b <my-fix-branch> master
53+
```
54+
55+
4. The fun part! Make your code changes. Make sure you:
56+
- Follow the [code conventions guide](https://github.com/NativeScript/NativeScript/blob/master/CodingConvention.md).
57+
- Follow the [commit message guidelines](https://github.com/NativeScript/NativeScript/blob/master/CONTRIBUTING.md#commit-messages)
58+
- Update the README if you make changes to the plugin API
59+
60+
5. Before you submit your PR:
61+
- Rebase your changes to the latest master: `git pull --rebase upstream master`.
62+
- Ensure your changes pass tslint validation. (run `npm run tslint` in the `src` folder).
63+
64+
6. Push your fork. If you have rebased you might have to use force-push your branch:
65+
```
66+
git push origin <my-fix-branch> --force
67+
```
68+
69+
7. [Submit your pull request](https://github.com/NativeScript/nativescript-dev-sass/compare) and compare to `NativeScript/nativescript-dev-sass`. Please, fill in the Pull Request template - it will help us better understand the PR and increase the chances of it getting merged quickly.
70+
71+
It's our turn from there on! We will review the PR and discuss changes you might have to make before merging it! Thanks!
72+
73+
## Where to Start
74+
75+
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-sass/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).

‎DevelopmentWorkflow.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Development Workflow
2+
3+
<!-- TOC depthFrom:2 -->
4+
5+
- [Prerequisites](#prerequisites)
6+
- [Develop locally](#develop-locally)
7+
8+
<!-- /TOC -->
9+
10+
11+
## Prerequisites
12+
13+
* Install your native toolchain and NativeScript as [described in the docs](https://docs.nativescript.org/start/quick-setup)
14+
15+
* Review [NativeScript plugins documentation](https://docs.nativescript.org/plugins/plugins) for more details on plugins development
16+
17+
18+
## Develop locally
19+
20+
For local development we recommend using the npm commands provided in the plugin's package.json
21+
22+
Basically executing a bunch of commands will be enough for you to start making changes to the plugin and see them live synced in the demo. It's up to you to decide which demo to use for development - TypeScript or TypeScript + Angular.
23+
24+
25+
To run and develop using TypeScript demo:
26+
```bash
27+
$ cd nativescript-dev-sass/src
28+
$ npm run demo.ios
29+
$ npm run demo.android
30+
```
31+
32+
After all the changes are done make sure to test them in all the demo apps.
33+
34+
For details on plugins development workflow, read [NativeScript plugins documentation](https://docs.nativescript.org/plugins/building-plugins#step-2-set-up-a-development-workflow) covering that topic.

‎README.md

+22-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
1-
SASS CSS pre-processor for NativeScript projects
2-
=======================================
3-
1+
# SASS CSS pre-processor for NativeScript projects
42
[![npm version](https://badge.fury.io/js/nativescript-dev-sass.svg)](https://badge.fury.io/js/nativescript-dev-sass)
53

6-
----------
74
This plugin uses the [node-sass compiler](https://www.npmjs.com/package/node-sass) to transpile SCSS files to CSS files in [NativeScript](https://www.nativescript.org/) projects.
85

6+
<!-- TOC depthFrom:2 -->
7+
8+
- [How to use](#how-to-use)
9+
- [LiveSync Support](#livesync-support)
10+
- [Breaking Changes](#breaking-changes)
11+
- [SASS @import syntax](#sass-import-syntax)
12+
- [Using file extensions with @import](#using-file-extensions-with-import)
13+
- [Contribute](#contribute)
14+
- [Get Help](#get-help)
15+
16+
<!-- /TOC -->
17+
918
## How to use
1019

1120
Add the plug-in to your project:
@@ -81,3 +90,12 @@ Node-sass will throw an error if the `@import 'variables';` syntax is used. As a
8190

8291
This is currently on the roadmap for node-sass 4.0. [See this issue for more detail](https://github.com/sass/node-sass/issues/1222).
8392

93+
94+
## Contribute
95+
We love PRs! Check out the [contributing guidelines](CONTRIBUTING.md). 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-sass/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
96+
97+
## Get Help
98+
Please, use [github issues](https://github.com/NativeScript/nativescript-dev-sass/issues) strictly for [reporting bugs](CONTRIBUTING.md#reporting-bugs) or [requesting features](CONTRIBUTING.md#requesting-new-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).
99+
100+
![](https://ga-beacon.appspot.com/UA-111455-24/nativescript/nativescript-dev-sass?pixel)
101+

0 commit comments

Comments
 (0)