Skip to content

Commit 9e16612

Browse files
authored
Merge pull request #165 from angular-redux/release/4.0.0
4.0.0 Staging branch
2 parents f07cdc0 + 5555ab0 commit 9e16612

15 files changed

+1317
-7021
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ npm-debug.log
33
.DS_Store
44
lib
55
es
6+
umd
67
coverage
78
*.tgz
89
examples/**/dist

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
# Contributing to ng-redux
22

3+
## Developing ng-redux
4+
5+
To run the project, simply `npm install`. Then, run tests via `npm run test` or build the entire project via `npm build`.
6+
7+
## Commit convention
8+
9+
ng-redux uses [`standard-version` convention](https://github.com/conventional-changelog/standard-version) which basically looks like this:
10+
11+
```bash
12+
typeOfCommit(locationOfChanges): Commit message
13+
```
14+
15+
Examples:
16+
17+
```bash
18+
fix(lib): Fix ng-redux library issue
19+
feat(build): Build system test watch
20+
```
21+
22+
And so on. The commits are then compiled into the changelog along with each release.
23+
324
## Release process
425

526
For any contributors with release rights:

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ For Angular 2 see [ng2-redux](https://github.com/wbuchwalter/ng2-redux).
55

66
[![build status](https://img.shields.io/travis/angular-redux/ng-redux/master.svg?style=flat-square)](https://travis-ci.org/ng-redux/ng-redux)
77
[![npm version](https://img.shields.io/npm/v/ng-redux.svg?style=flat-square)](https://www.npmjs.com/package/ng-redux)
8+
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org)
89

910

1011
*ngRedux lets you easily connect your angular components with Redux.*
@@ -23,22 +24,32 @@ For Angular 2 see [ng2-redux](https://github.com/wbuchwalter/ng2-redux).
2324

2425
## Installation
2526
#### npm
27+
2628
```js
2729
npm install --save ng-redux
2830
```
31+
2932
#### bower (deprecated)
30-
**Warning!** ng-redux will stop being published to bower when version 4.0.0 hits. Bower recommends using yarn and webpack as an alternative for new projects.
33+
**Warning!** Starting with 4.0.0, we will no longer be publishing new releases on Bower. You can continue using Bower for old releases, or point your bower config to the UMD build hosted on unpkg that mirrors our npm releases.
3134

32-
```js
33-
bower install --save ng-redux
35+
```json
36+
{
37+
"dependencies": {
38+
"ng-redux": "https://unpkg.com/ng-redux/umd/ng-redux.min.js"
39+
}
40+
}
3441
```
3542

3643
Add the following script tag to your html:
37-
3844
```html
3945
<script src="bower_components/ng-redux/dist/ng-redux.js"></script>
4046
```
4147

48+
Or directly from unpkg
49+
```html
50+
<script src="https://unpkg.com/ng-redux/umd/ng-redux.min.js"></script>
51+
```
52+
4253
## Quick Start
4354

4455
#### Initialization

bower.json

Lines changed: 0 additions & 23 deletions
This file was deleted.

commitlint.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
extends: ['@commitlint/config-conventional'],
3+
};

0 commit comments

Comments
 (0)