Skip to content

Commit 33e626a

Browse files
crutchcorncrutchcorn
committed
docs: add various docs files
1 parent 91c6585 commit 33e626a

File tree

6 files changed

+130
-31
lines changed

6 files changed

+130
-31
lines changed

Diff for: ‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
All notable changes are described on the [Releases](https://github.com/reduxjs/react-redux/releases) page.

Diff for: ‎CODE_OF_CONDUCT.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4+
5+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
6+
7+
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8+
9+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10+
11+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12+
13+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

Diff for: ‎CONTRIBUTING.md

+65
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,70 @@
1+
# Contributing
2+
3+
We are open to, and grateful for, any contributions made by the community. By contributing to Angular Redux, you agree to abide by the [code of conduct](https://github.com/reduxjs/angular-redux/blob/master/CODE_OF_CONDUCT.md).
4+
5+
Please review the [Redux Style Guide](https://redux.js.org/style-guide/style-guide) in the Redux docs to keep track of our best practices.
6+
7+
## Reporting Issues and Asking Questions
8+
9+
Before opening an issue, please search the [issue tracker](https://github.com/reduxjs/angular-redux/issues) to make sure your issue hasn't already been reported.
10+
11+
Please ask any general and implementation specific questions on [Stack Overflow with a Redux tag](http://stackoverflow.com/questions/tagged/redux?sort=votes&pageSize=50) for support.
12+
13+
## Development
14+
15+
Visit the [Issue tracker](https://github.com/reduxjs/angular-redux/issues) to find a list of open issues that need attention.
16+
17+
Fork, then clone the repo:
18+
19+
```
20+
git clone https://github.com/your-username/angular-redux.git
21+
```
22+
23+
This repository uses Yarn v4 to manage packages. You'll need to have Yarn v1.22 installed globally on your system first, as Yarn v4 depends on that being available first. Install dependencies with:
24+
25+
```
26+
yarn install
27+
```
28+
29+
### Building
30+
31+
Running the `build` task will create an ESM build.
32+
33+
```
34+
yarn build
35+
```
36+
37+
### Testing and Linting
38+
39+
To run the tests:
40+
41+
```
42+
yarn test
43+
```
44+
45+
### New Features
46+
47+
Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.
48+
49+
## Submitting Changes
50+
51+
- Open a new issue in the [Issue tracker](https://github.com/reduxjs/angular-redux/issues).
52+
- Fork the repo.
53+
- Create a new feature branch based off the `main` branch.
54+
- Make sure all tests pass and there are no linting errors.
55+
- Submit a pull request, referencing any issues it addresses.
56+
57+
Please try to keep your pull request focused in scope and avoid including unrelated commits.
58+
59+
After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.
60+
61+
Thank you for contributing!
62+
63+
164
# Cutting a release
265

66+
If you are a maintainer and want to cut a release, follow these steps:
67+
368
- `yarn build`
469
- `cd dist && angular-redux`
570
- `npm publish`

Diff for: ‎LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2024-present Corbin Crutchley
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Diff for: ‎netlify.toml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[build]
2+
base = "website"
3+
publish = "website/build"
4+
command = "yarn && yarn build && cp _redirects ./build"
5+
ignore = "git diff --quiet HEAD^ HEAD -- ../docs/ . ../netlify.toml"
6+
7+
[build.environment]
8+
NODE_VERSION = "20"
9+
NODE_OPTIONS = "--max_old_space_size=4096"
10+
NETLIFY_USE_YARN = "true"
11+
YARN_VERSION = "1.22.10"
12+
13+
14+
[[plugins]]
15+
package = "netlify-plugin-cache"
16+
[plugins.inputs]
17+
paths = [
18+
"node_modules/.cache",
19+
"website/node_modules/.cache",
20+
".yarn/.cache"
21+
]
22+

Diff for: ‎projects/angular-redux/README.md

+8-31
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Performant and flexible.
55

66
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/reduxjs/angular-redux/test.yml?style=flat-square) [![npm version](https://img.shields.io/npm/v/@reduxjs/angular-redux.svg?style=flat-square)](https://www.npmjs.com/package/@reduxjs/angular-redux)
77
[![npm downloads](https://img.shields.io/npm/dm/@reduxjs/angular-redux.svg?style=flat-square)](https://www.npmjs.com/package/@reduxjs/angular-redux)
8+
[![#redux channel on Discord](https://img.shields.io/badge/[email protected]?style=flat-square)](http://www.reactiflux.com)
89

910
## Installation
1011

@@ -48,34 +49,10 @@ yarn add @reduxjs/angular-redux
4849

4950
You'll also need to [install Redux](https://redux.js.org/introduction/installation) and [set up a Redux store](https://redux.js.org/recipes/configuring-your-store/) in your app.
5051

51-
This assumes that you’re using [npm](http://npmjs.com/) package manager
52-
with a module bundler like [Webpack](https://webpack.js.org/) or
53-
[Browserify](http://browserify.org/) to consume [CommonJS
54-
modules](https://webpack.js.org/api/module-methods/#commonjs).
55-
56-
# Usage
57-
58-
The following Angular component works as-expected:
59-
60-
```typescript
61-
import { Component } from "@angular/core";
62-
import { injectSelector, injectDispatch } from "@reduxjs/angular-redux";
63-
import { decrement, increment } from "./store/counter-slice";
64-
import { RootState } from "./store";
65-
66-
@Component({
67-
selector: "app-root",
68-
standalone: true,
69-
template: `
70-
<button (click)="dispatch(increment())">Increment</button>
71-
<span>{{ count() }}</span>
72-
<button (click)="dispatch(decrement())">Decrement</button>
73-
`,
74-
})
75-
export class AppComponent {
76-
count = injectSelector((state: RootState) => state.counter.value);
77-
dispatch = injectDispatch();
78-
increment = increment;
79-
decrement = decrement;
80-
}
81-
```
52+
## Documentation
53+
54+
The React Redux docs are published at **https://angular-redux.js.org** .
55+
56+
## License
57+
58+
[MIT](LICENSE.md)

0 commit comments

Comments
 (0)