Skip to content

Commit 8a996a4

Browse files
NetanelBasalNetanelBasal
committed
chore(general): 🤖 update readme
1 parent c07e4f8 commit 8a996a4

14 files changed

+82537
-12871
lines changed

‎.husky/commit-msg

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
. "$(dirname "$0")/_/husky.sh"
3+
4+
npx --no-install commitlint --edit $1

‎CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing to Elf
2+
3+
🙏 We would ❤️ for you to contribute to effects and help make it even better than it is today!
4+
5+
## <a name="rules"></a> Coding Rules
6+
7+
To ensure consistency throughout the source code, keep these rules in mind as you are working:
8+
9+
- All features or bug fixes **must be tested** by one or more specs (unit-tests).
10+
- All public API methods **must be documented**.
11+
12+
## <a name="commit"></a> Commit Message Guidelines
13+
14+
We have very precise rules over how our git commit messages can be formatted. This leads to **more
15+
readable messages** that are easy to follow when looking through the **project history**. But also,
16+
we use the git commit messages to **generate the Akita changelog**.
17+
18+
### Commit Message Format
19+
20+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
21+
format that includes a **type**, a **scope** and a **subject**:
22+
23+
```
24+
<type>(<scope>): <subject>
25+
<BLANK LINE>
26+
<body>
27+
<BLANK LINE>
28+
<footer>
29+
```
30+
31+
The **header** is mandatory and the **scope** of the header is optional.
32+
33+
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
34+
to read on GitHub as well as in various git tools.
35+
36+
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
37+
38+
Samples: (even more [samples](https://github.com/angular/angular/commits/master))
39+
40+
```
41+
docs(changelog): update changelog to beta.5
42+
```
43+
44+
```
45+
fix(release): need to depend on latest rxjs and zone.js
46+
47+
The version in our package.json gets copied to the one we publish, and users need the latest of these.
48+
```

‎LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019-2020 Netanel Basal.
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
13+
all 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
21+
THE SOFTWARE.

‎README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
1+
<p align="center">
2+
<img width="15%" height="15%" src="effects.png">
3+
</p>
4+
5+
<br />
6+
17
> A framework-agnostic RxJS effects implementation
28
9+
<br />
10+
11+
![@ngneat/effects](https://github.com/ngneat/elf/actions/workflows/ci.yml/badge.svg]https://github.com/ngneat/effects/actions/workflows/ci.yml)
12+
![commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)
13+
![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)
14+
![coc-badge](https://img.shields.io/badge/codeof-conduct-ff69b4.svg?style=flat-square)
15+
![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e5079.svg?style=flat-square]https://github.com/semantic-release/semantic-release)
16+
![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square]https://github.com/prettier/prettier)
17+
18+
<br />
19+
320
# Effects
421

522
First, we need to initialize the the library by calling the `initEffects()` function:
@@ -69,7 +86,7 @@ The effects we pass are tied to the component life cycle hook and will be destro
6986
## Use with Angular
7087
First, install the package: `npm i @ngneat/effects-ng`.
7188

72-
89+
TODO
7390

7491
# Effect Functions
7592
To use an `effect` function we first need to create it by using the `createEffectFn` function:
@@ -153,3 +170,5 @@ export class TodosComponent {
153170
}
154171
}
155172
```
173+
174+
<div>Icons made by <a href="https://www.freepik.com" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>

‎changelog.config.js

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
module.exports = {
2+
disableEmoji: false,
3+
list: [
4+
'test',
5+
'feat',
6+
'fix',
7+
'chore',
8+
'docs',
9+
'refactor',
10+
'style',
11+
'ci',
12+
'perf',
13+
],
14+
maxMessageLength: 64,
15+
minMessageLength: 3,
16+
questions: ['type', 'scope', 'subject', 'body', 'breaking', 'issues'],
17+
scopes: [
18+
'effects',
19+
'effects-ng',
20+
'effects-hooks',
21+
'general',
22+
],
23+
types: {
24+
chore: {
25+
description: 'Build process or auxiliary tool changes',
26+
emoji: '🤖',
27+
value: 'chore',
28+
},
29+
ci: {
30+
description: 'CI related changes',
31+
emoji: '😺',
32+
value: 'ci',
33+
},
34+
docs: {
35+
description: 'Documentation only changes',
36+
emoji: '📘',
37+
value: 'docs',
38+
},
39+
feat: {
40+
description: 'A new feature',
41+
emoji: '🔥',
42+
value: 'feat',
43+
},
44+
fix: {
45+
description: 'A bug fix',
46+
emoji: '🐞',
47+
value: 'fix',
48+
},
49+
perf: {
50+
description: 'A code change that improves performance',
51+
emoji: '🏎',
52+
value: 'perf',
53+
},
54+
refactor: {
55+
description: 'A code change that neither fixes a bug or adds a feature',
56+
emoji: '💡',
57+
value: 'refactor',
58+
},
59+
release: {
60+
description: 'Create a release commit',
61+
emoji: '🤩',
62+
value: 'release',
63+
},
64+
style: {
65+
description: 'Markup, white-space, formatting, missing semi-colons...',
66+
emoji: '💄',
67+
value: 'style',
68+
},
69+
test: {
70+
description: 'Adding missing tests',
71+
emoji: '🥳',
72+
value: 'test',
73+
},
74+
},
75+
};

‎effects.png

16.3 KB
Loading

‎libs/effects-ng/package.json

+31-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,35 @@
11
{
22
"name": "@ngneat/effects-ng",
3-
"version": "0.0.1",
4-
"peerDependencies": {
5-
"@angular/common": "^12.2.0",
6-
"@angular/core": "^12.2.0"
3+
"version": "1.0.0-beta.0",
4+
"description": "A framework-agnostic RxJS effects implementation",
5+
"publishConfig": {
6+
"access": "public"
7+
},
8+
"bugs": {
9+
"url": "https://github.com/ngneat/effects/issues"
10+
},
11+
"homepage": "https://github.com/ngneat/effects#readme",
12+
"repository": {
13+
"type": "git",
14+
"url": "https://github.com/ngneat/effects"
715
},
8-
"dependencies": {
9-
"tslib": "^2.3.0"
16+
"keywords": [
17+
"rxjs",
18+
"state management",
19+
"reactive state management",
20+
"js state management",
21+
"rxjs effects",
22+
"actions",
23+
"angular effects",
24+
"effects"
25+
],
26+
"author": {
27+
"name": "Netanel Basal",
28+
"email": "[email protected]",
29+
"url": "https://netbasal.com"
30+
},
31+
"license": "MIT",
32+
"peerDependencies": {
33+
"rxjs": "*"
1034
}
11-
}
35+
}

‎libs/effects/package.json

+32-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,34 @@
11
{
22
"name": "@ngneat/effects",
3-
"version": "0.0.1"
4-
}
3+
"version": "1.0.0-beta.0",
4+
"description": "A framework-agnostic RxJS effects implementation",
5+
"publishConfig": {
6+
"access": "public"
7+
},
8+
"bugs": {
9+
"url": "https://github.com/ngneat/effects/issues"
10+
},
11+
"homepage": "https://github.com/ngneat/effects#readme",
12+
"repository": {
13+
"type": "git",
14+
"url": "https://github.com/ngneat/effects"
15+
},
16+
"keywords": [
17+
"rxjs",
18+
"state management",
19+
"reactive state management",
20+
"js state management",
21+
"rxjs effects",
22+
"actions",
23+
"effects"
24+
],
25+
"author": {
26+
"name": "Netanel Basal",
27+
"email": "[email protected]",
28+
"url": "https://netbasal.com"
29+
},
30+
"license": "MIT",
31+
"peerDependencies": {
32+
"rxjs": "*"
33+
}
34+
}

‎libs/hooks/package.json

+34-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,35 @@
11
{
2-
"name": "@ngneat/effect-hooks",
3-
"version": "0.0.1"
4-
}
2+
"name": "@ngneat/effects-hooks",
3+
"version": "1.0.0-beta.0",
4+
"description": "A framework-agnostic RxJS effects implementation",
5+
"publishConfig": {
6+
"access": "public"
7+
},
8+
"bugs": {
9+
"url": "https://github.com/ngneat/effects/issues"
10+
},
11+
"homepage": "https://github.com/ngneat/effects#readme",
12+
"repository": {
13+
"type": "git",
14+
"url": "https://github.com/ngneat/effects"
15+
},
16+
"keywords": [
17+
"rxjs",
18+
"state management",
19+
"reactive state management",
20+
"js state management",
21+
"rxjs effects",
22+
"actions",
23+
"react effects",
24+
"effects"
25+
],
26+
"author": {
27+
"name": "Netanel Basal",
28+
"email": "[email protected]",
29+
"url": "https://netbasal.com"
30+
},
31+
"license": "MIT",
32+
"peerDependencies": {
33+
"rxjs": "*"
34+
}
35+
}

0 commit comments

Comments
 (0)