Merge branch 'master' into master

ngx-builders · Oct 25, 2019 · d55fdb7 · d55fdb7
2 parents 0d096a2 + 580b381
commit d55fdb7
Show file tree

Hide file tree

Showing 6 changed files with 249 additions and 17 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -0,0 +1,41 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "contributors": [
+    {
+      "login": "haroon786",
+      "name": "HaroonJ",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/20164301?v=4",
+      "profile": "https://github.com/haroon786",
+      "contributions": [
+        "code"
+      ]
+    },
+      {
+      "login": "ankitsaini345",
+      "name": "Ankit Saini",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/37847177?v=4",
+      "profile": "https://github.com/ankitsaini345",
+      "contributions": [
+        "code"
+      ]
+    },
+     {
+      "login": "santoshyadav198613",
+      "name": "Santosh Yadav",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/11923975?v=4",
+      "profile": "https://www.santoshyadav.dev",
+      "contributions": [
+        "code"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "projectName": "ngx-bulma",
+  "projectOwner": "santoshyadav198613",
+  "repoType": "github",
+  "repoHost": "https://github.com"
+}
diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml
@@ -0,0 +1,28 @@
+name: master
+
+on: 
+  push:
+    branches:
+      - master
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: npm install, build, and test
+      run: |
+        npm install
+        npm run build:lib
+        npm run build --bulma-app
+      env:
+        CI: true
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -1,6 +1,9 @@
-name: Node CI
+name: Pull Requests
 
-on: [push, pull_request]
+on:
+  pull_request:
+    branches:
+      - master
 
 jobs:
   build:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,152 @@
+# Developing
+
+## Setup
+
+```shell
+npm install
+```
+
+## Build Libraries
+```shell
+npm run build:lib
+```
+
+## Build Portal
+```shell
+npm run serve:app
+```
+
+## Submitting Pull Requests
+
+**Please follow these basic steps to simplify pull request reviews. If you don't you'll probably just be asked to anyway.**
+
+- Please rebase your branch against the current master.
+- Run the `npm i` command to make sure your development dependencies are up-to-date.
+- If you've added new functionality, **please** include tests which validate its behavior.
+- Make reference to possible [issues](https://github.com/santoshyadav198613/ngx-bulma/issues) on PR comment.
+
+## Submitting bug reports
+
+- Search through issues to see if a previous issue has already been reported and/or fixed.
+- Provide a _small_ reproduction using a GitHub repository.
+- Please detail the affected browser(s) and operating system(s).
+- Please be sure to state which version of Angular, node and npm you're using.
+
+## Submitting new features
+
+- We value keeping the API surface small and concise, which factors into whether new features are accepted.
+- Submit an issue with the prefix `RFC:` with your feature request.
+- The feature will be discussed and considered.
+- Once the PR is submitted, it will be reviewed and merged once approved.
+
+## <a name="commit"></a> Commit Message Guidelines
+
+We have very precise rules over how our git commit messages can be formatted. This leads to **more
+readable messages** that are easy to follow when looking through the **project history**. But also,
+we use the git commit messages to **generate the change log**.
+
+### Commit Message Format
+
+Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
+format that includes a **type**, a **scope** and a **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
+to read on GitHub as well as in various git tools.
+
+The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
+
+
+```
+docs(changelog): update changelog to beta.5
+```
+
+```
+fix(release): need to depend on latest rxjs and zone.js
+
+The version in our package.json gets copied to the one we publish, and users need the latest of these.
+```
+
+### Revert
+
+If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+
+Must be one of the following:
+
+- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+- **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+- **docs**: Documentation only changes
+- **feat**: A new feature
+- **fix**: A bug fix
+- **perf**: A code change that improves performance
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- **test**: Adding missing tests or correcting existing tests
+
+### Scope
+
+The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages.
+
+The following is the list of supported scopes:
+
+- **breadcrumb**
+- **card**
+- **menu**
+- **example**
+- **message**
+- **schematics**
+- **modal**
+- **pagination**
+- **panel**
+- **tabs**
+- **dropdown**
+
+
+### Subject
+
+The subject contains a succinct description of the change:
+
+- use the imperative, present tense: "change" not "changed" nor "changes"
+- don't capitalize the first letter
+- no dot (.) at the end
+
+### Body
+
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
+
+Example:
+
+```
+feat(scope): commit message
+
+BREAKING CHANGES:
+
+Describe breaking changes here
+
+BEFORE:
+
+Previous code example here
+
+AFTER:
+
+New code example here
+```
diff --git a/README.md b/README.md
@@ -1,28 +1,35 @@
-![](https://github.com/santoshyadav198613/ngx-bulma/workflows/Node%20CI/badge.svg)
-# NgxBulma
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.3.2.
+# ngx2-bulma
+
+Angular Library with Bulma CSS
 
-## Development server
+![](https://github.com/santoshyadav198613/ngx-bulma/workflows/Node%20CI/badge.svg)
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+## Documentation
 
-## Code scaffolding
+Check out our website: [ngx2-bulma](https://ngx2-bulma.netlify.com/).
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+## Contributing
 
-## Build
+ngx2-bulma is a community-driven project. Read our [contributing guidelines](./CONTRIBUTING.md) on how to get involved.
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
+## Contributors ✨
 
-## Running unit tests
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/haroon786"><img src="https://avatars0.githubusercontent.com/u/20164301?v=4" width="100px;" alt="HaroonJ"/><br /><sub><b>HaroonJ</b></sub></a><br /><a href="https://github.com/santoshyadav198613/ngx-bulma/commits?author=haroon786" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/ankitsaini345"><img src="https://avatars2.githubusercontent.com/u/37847177?v=4" width="100px;" alt="Ankit Saini"/><br /><sub><b>Ankit Saini</b></sub></a><br /><a href="https://github.com/santoshyadav198613/ngx-bulma/commits?author=ankitsaini345" title="Code">💻</a></td>
+    <td align="center"><a href="https://www.santoshyadav.dev"><img src="https://avatars3.githubusercontent.com/u/11923975?v=4" width="100px;" alt="Santosh Yadav"/><br /><sub><b>Santosh Yadav</b></sub></a><br /><a href="https://github.com/santoshyadav198613/ngx-bulma/commits?author=santoshyadav198613" title="Code">💻</a></td>
+  </tr>
+</table>
 
-## Running end-to-end tests
+<!-- ALL-CONTRIBUTORS-LIST:END -->
 
-Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
 
-## Further help
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
diff --git a/package.json b/package.json
@@ -6,6 +6,7 @@
     "start": "ng serve",
     "build:lib": "ng build ngx-bulma",
     "serve:app": "ng serve bulma-app -o",
+    "build-docs": "npm run build:lib && ng build bulma-app",
     "build": "ng build",
     "test": "ng test",
     "lint": "ng lint",