Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(app): add LICENSE and various guides
- Loading branch information
Showing
7 changed files
with
167 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# http://editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
indent_style = space | ||
indent_size = 2 | ||
end_of_line = lf | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.md] | ||
insert_final_newline = false | ||
trim_trailing_whitespace = false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
### Build generated | ||
/dist | ||
/demo/assets | ||
/demo/bundle.js* | ||
/temp/ | ||
/coverage/ | ||
|
||
### Package manager generated | ||
/node_modules/ | ||
/typings/ | ||
|
||
### Logs | ||
*.log | ||
|
||
### OS/IDE generated files | ||
Thumbs.db | ||
.DS_Store | ||
.vscode | ||
.idea | ||
*.iml |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Contributing | ||
|
||
We are always looking for quality contributions. | ||
|
||
**Note**: If you just have a question that won't necessarily result in a change, such as asking how something works or how to contribute, please use [StackOverflow](http://stackoverflow.com/questions/tagged/ng-lightning) (`ng-lightning` tag) instead of filing an issue. | ||
|
||
## Bug Reporting | ||
If you think you've found a bug, please create a new issue. Be sure to include the following information: | ||
|
||
* The version of Angular you are using. | ||
* The version of ng-lightning you are using. | ||
* What you did. | ||
* What you expected to happen. | ||
* What actually happened. | ||
|
||
Please include as much detail as possible to help us properly address your issue. If we need to triage issues and constantly ask people for more detail, that's time taken away from actually fixing issues. Help us be as efficient as possible by including a lot of detail in your issues. | ||
|
||
A minimal reproduce scenario using http://plnkr.co/ allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem. | ||
|
||
## Pull Requests | ||
If you want to contribute code, please use a pull request. This is the fastest way to evaluate your code and to merge it into the code base. | ||
|
||
Please assure that you are submitting quality code, specifically make sure that your Pull Request: | ||
* has accompanying tests and all the tests are passing | ||
* doesn't break the build | ||
* your commit message conforms with [Angular conventions](https://github.com/stevemao/conventional-changelog-angular/blob/master/convention.md) | ||
|
||
If you've never submitted code before, this [developer guide](DEVELOPER.md) may help you. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# Development Environment | ||
|
||
We have a very lightweight development environment that makes updating code fast and easy. This is a step-by-step guide to setting up a local development environment that will let you contribute back to the project. | ||
|
||
## Prerequisites | ||
|
||
Make sure you have installed and configured the following products on your development machine: | ||
|
||
* Git | ||
* Node.js | ||
* Chrome browser (run tests) | ||
|
||
## Fork & Checkout | ||
|
||
Go to [ng-lightning repository](https://github.com/ng-lightning/ng-lightning) and click the "Fork" button. Follow the [GitHub documentation](https://help.github.com/articles/fork-a-repo) for forking and cloning. | ||
|
||
You can then add `upstream` path to monitor the main repository that active development happens on. While you won't have push access to `upstream`, you will have pull access, allowing you to pull in the latest code whenever you want. | ||
|
||
Run the following in your repository: | ||
|
||
```bash | ||
git remote add upstream git@github.com:ng-lightning/ng-lightning.git | ||
``` | ||
|
||
## Install | ||
|
||
Get all the necessary dependencies needed to build, test and run demo page by running: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
## Commands | ||
|
||
### Build | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
If you want to watch your source files for changes and build every time use: | ||
```bash | ||
npm run build:watch | ||
``` | ||
|
||
**Note**: Generated output is placed into the `dist` folder. | ||
|
||
### Tests | ||
|
||
```bash | ||
npm test | ||
``` | ||
|
||
If you want to run your tests in watch mode, you can use: | ||
```bash | ||
npm run tdd | ||
``` | ||
|
||
### Demo | ||
|
||
The best way to see your changes in action, is to use our demo page locally. Run: | ||
```bash | ||
npm start | ||
``` | ||
which will create a development server accessible through `http:localhost:1111`. | ||
In conjunction with `npm run build:watch` in another command tab you have a fully working environment! | ||
|
||
All demo resources can be found in the `/demo` folder. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License | ||
|
||
Copyright (c) 2016 | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters