Skip to content

4.0.0 Staging branch #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Feb 7, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ npm-debug.log
.DS_Store
lib
es
umd
coverage
*.tgz
examples/**/dist
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
# Contributing to ng-redux

## Developing ng-redux

To run the project, simply `npm install`. Then, run tests via `npm run test` or build the entire project via `npm build`.

## Commit convention

ng-redux uses [`standard-version` convention](https://github.com/conventional-changelog/standard-version) which basically looks like this:

```bash
typeOfCommit(locationOfChanges): Commit message
```

Examples:

```bash
fix(lib): Fix ng-redux library issue
feat(build): Build system test watch
```

And so on. The commits are then compiled into the changelog along with each release.

## Release process

For any contributors with release rights:
Expand Down
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ For Angular 2 see [ng2-redux](https://github.com/wbuchwalter/ng2-redux).

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


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

## Installation
#### npm

```js
npm install --save ng-redux
```

#### bower (deprecated)
**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.
**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.

```js
bower install --save ng-redux
```json
{
"dependencies": {
"ng-redux": "https://unpkg.com/ng-redux/umd/ng-redux.min.js"
}
}
```

Add the following script tag to your html:

```html
<script src="bower_components/ng-redux/dist/ng-redux.js"></script>
```

Or directly from unpkg
```html
<script src="https://unpkg.com/ng-redux/umd/ng-redux.min.js"></script>
```

## Quick Start

#### Initialization
Expand Down
23 changes: 0 additions & 23 deletions bower.json

This file was deleted.

3 changes: 3 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
extends: ['@commitlint/config-conventional'],
};
Loading