Skip to content

Commit 5238d51

Browse files
NetanelBasalNetanelBasal
committedOct 16, 2022
chore(query): 🤖 add packages info
1 parent 843d73f commit 5238d51

17 files changed

+2040
-39
lines changed
 

‎.github/ISSUE_TEMPLATE/1-bug-report.yaml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug Report
2+
description: Report a bug in the ngneat/query Library
3+
4+
body:
5+
- type: dropdown
6+
id: affected-packages
7+
attributes:
8+
label: Which @ngneat/query-* package(s) are the source of the bug?
9+
options:
10+
- query
11+
- devtools
12+
- Don't known / other
13+
multiple: true
14+
validations:
15+
required: true
16+
17+
- type: dropdown
18+
id: is-regression
19+
attributes:
20+
label: Is this a regression?
21+
options:
22+
- 'Yes'
23+
- 'No'
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: description
29+
attributes:
30+
label: Description
31+
validations:
32+
required: true
33+
34+
- type: input
35+
id: reproduction
36+
attributes:
37+
label: Please provide a link to a minimal reproduction of the bug
38+
39+
- type: textarea
40+
id: exception-or-error
41+
attributes:
42+
label: Please provide the exception or error you saw
43+
render: true
44+
45+
- type: textarea
46+
id: environment
47+
attributes:
48+
label: Please provide the environment you discovered this bug in
49+
render: true
50+
51+
- type: textarea
52+
id: other
53+
attributes:
54+
label: Anything else?
55+
56+
- type: dropdown
57+
id: contribute
58+
attributes:
59+
label: Do you want to create a pull request?
60+
options:
61+
- 'Yes'
62+
- 'No'
63+
validations:
64+
required: true

‎.github/ISSUE_TEMPLATE/2-feature-request.yaml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: 'Feature Request'
2+
description: Suggest a feature for ngneat/query Library
3+
4+
body:
5+
- type: dropdown
6+
id: affected-packages
7+
attributes:
8+
label: Which @ngneat/query-* package(s) are relevant/releated to the feature request?
9+
options:
10+
- query
11+
- devtools
12+
multiple: true
13+
14+
- type: textarea
15+
id: description
16+
attributes:
17+
label: Description
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: proposed-solution
23+
attributes:
24+
label: Proposed solution
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: alternatives-considered
30+
attributes:
31+
label: Alternatives considered
32+
validations:
33+
required: true
34+
35+
- type: dropdown
36+
id: contribute
37+
attributes:
38+
label: Do you want to create a pull request?
39+
options:
40+
- 'Yes'
41+
- 'No'
42+
validations:
43+
required: true

‎.github/ISSUE_TEMPLATE/3-support-request.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: 'Support Request'
3+
about: Questions and requests for support
4+
---
5+
6+
Please do not file questions or support requests on the GitHub issues tracker.
7+
8+
You can get your questions answered using other communication channels. Please see:
9+
10+
https://github.com/ngneat/query/discussions
11+
12+
Thank you!

‎.github/PULL_REQUEST_TEMPLATE.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## PR Checklist
2+
3+
Please check if your PR fulfills the following requirements:
4+
5+
- [ ] The commit message follows our guidelines: https://github.com/ngneat/query/blob/master/CONTRIBUTING.md#commit
6+
- [ ] Tests for the changes have been added (for bug fixes / features)
7+
- [ ] Docs have been added / updated (for bug fixes / features)
8+
9+
## PR Type
10+
11+
What kind of change does this PR introduce?
12+
13+
<!-- Please check the one that applies to this PR using "x". -->
14+
15+
```
16+
[ ] Bugfix
17+
[ ] Feature
18+
[ ] Code style update (formatting, local variables)
19+
[ ] Refactoring (no functional changes, no api changes)
20+
[ ] Build related changes
21+
[ ] CI related changes
22+
[ ] Documentation content changes
23+
[ ] Other... Please describe:
24+
```
25+
26+
## What is the current behavior?
27+
28+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
29+
30+
Issue Number: N/A
31+
32+
## What is the new behavior?
33+
34+
## Does this PR introduce a breaking change?
35+
36+
```
37+
[ ] Yes
38+
[ ] No
39+
```
40+
41+
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
42+
43+
## Other information

‎.github/workflows/ci.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: '@ngneat/query'
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
strategy:
12+
fail-fast: true
13+
14+
steps:
15+
- uses: actions/checkout@v2
16+
- name: Cache node modules
17+
uses: actions/cache@v2
18+
env:
19+
cache-name: cache-node-modules
20+
with:
21+
path: ~/.npm
22+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
23+
restore-keys: |
24+
${{ runner.os }}-build-${{ env.cache-name }}-
25+
${{ runner.os }}-build-
26+
${{ runner.os }}-
27+
- uses: actions/setup-node@v2
28+
with:
29+
node-version: '14'
30+
cache: 'npm'
31+
32+
- name: Install dependencies
33+
run: npm i
34+
35+
- name: Run Build
36+
run: npm run build:all
37+
38+
- name: Run unit tests
39+
run: npm run test:all

‎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 netanel7799@gmail.com. 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

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

‎changelog.config.js

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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: ['query', 'devtools'],
18+
types: {
19+
chore: {
20+
description: 'Build process or auxiliary tool changes',
21+
emoji: '🤖',
22+
value: 'chore',
23+
},
24+
ci: {
25+
description: 'CI related changes',
26+
emoji: '😺',
27+
value: 'ci',
28+
},
29+
docs: {
30+
description: 'Documentation only changes',
31+
emoji: '📘',
32+
value: 'docs',
33+
},
34+
feat: {
35+
description: 'A new feature',
36+
emoji: '🔥',
37+
value: 'feat',
38+
},
39+
fix: {
40+
description: 'A bug fix',
41+
emoji: '🐞',
42+
value: 'fix',
43+
},
44+
perf: {
45+
description: 'A code change that improves performance',
46+
emoji: '🏎',
47+
value: 'perf',
48+
},
49+
refactor: {
50+
description: 'A code change that neither fixes a bug or adds a feature',
51+
emoji: '💡',
52+
value: 'refactor',
53+
},
54+
release: {
55+
description: 'Create a release commit',
56+
emoji: '🤩',
57+
value: 'release',
58+
},
59+
style: {
60+
description: 'Markup, white-space, formatting, missing semi-colons...',
61+
emoji: '💄',
62+
value: 'style',
63+
},
64+
test: {
65+
description: 'Adding missing tests',
66+
emoji: '🥳',
67+
value: 'test',
68+
},
69+
},
70+
};

0 commit comments

Comments
 (0)
Please sign in to comment.