Skip to content

Commit e478541

Browse files
NetanelBasalNetanelBasal
committedDec 21, 2020
chore: 🤖 init
·
v1.3.0v1.2.0
1 parent 781bfb1 commit e478541

32 files changed

+11814
-5002
lines changed
 

‎.all-contributorsrc

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"projectName": "bind-query-params",
3+
"projectOwner": "@ngneat",
4+
"repoType": "github",
5+
"repoHost": "https://github.com",
6+
"files": [
7+
"README.md"
8+
],
9+
"imageSize": 100,
10+
"commit": true,
11+
"commitConvention": "angular",
12+
"contributors": [],
13+
"contributorsPerLine": 7
14+
}

‎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

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

‎ISSUE_TEMPLATE.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<!--
2+
PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATION.
3+
4+
ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION.
5+
-->
6+
7+
## I'm submitting a...
8+
9+
<!-- Check one of the following options with "x" -->
10+
<pre><code>
11+
[ ] Regression (a behavior that used to work and stopped working in a new release)
12+
[ ] Bug report <!-- Please search GitHub for a similar issue or PR before submitting -->
13+
[ ] Performance issue
14+
[ ] Feature request
15+
[ ] Documentation issue or request
16+
[ ] Support request
17+
[ ] Other... Please describe:
18+
</code></pre>
19+
20+
## Current behavior
21+
22+
<!-- Describe how the issue manifests. -->
23+
24+
## Expected behavior
25+
26+
<!-- Describe what the desired behavior would be. -->
27+
28+
## Minimal reproduction of the problem with instructions
29+
30+
## What is the motivation / use case for changing the behavior?
31+
32+
<!-- Describe the motivation or the concrete use case. -->
33+
34+
## Environment
35+
36+
<pre><code>
37+
Angular version: X.Y.Z
38+
<!-- Check whether this is still an issue in the most recent Angular version -->
39+
40+
Browser:
41+
- [ ] Chrome (desktop) version XX
42+
- [ ] Chrome (Android) version XX
43+
- [ ] Chrome (iOS) version XX
44+
- [ ] Firefox version XX
45+
- [ ] Safari (desktop) version XX
46+
- [ ] Safari (iOS) version XX
47+
- [ ] IE version XX
48+
- [ ] Edge version XX
49+
50+
For Tooling issues:
51+
- Node version: XX <!-- run `node --version` -->
52+
- Platform: <!-- Mac, Linux, Windows -->
53+
54+
Others:
55+
<!-- Anything else relevant? Operating system version, IDE, package manager, HTTP server, ... -->
56+
</code></pre>

‎LICENSE

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

‎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: 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

‎README.md

+57-14
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,70 @@
1-
# BindQueryParams
1+
<p align="center">
2+
<img width="20%" height="20%" src="./logo.svg">
3+
</p>
24

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 11.0.5.
5+
<br />
46

5-
## Development server
7+
[![MIT](https://img.shields.io/packagist/l/doctrine/orm.svg?style=flat-square)]()
8+
[![commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)]()
9+
[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)]()
10+
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
11+
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)
12+
[![ngneat](https://img.shields.io/badge/@-ngneat-383636?style=flat-square&labelColor=8f68d4)](https://github.com/ngneat/)
13+
[![spectator](https://img.shields.io/badge/tested%20with-spectator-2196F3.svg?style=flat-square)]()
614

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
15+
> The Library Slogan
816
9-
## Code scaffolding
17+
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aliquid assumenda atque blanditiis cum delectus eligendi ipsam iste iure, maxime modi molestiae nihil obcaecati odit officiis pariatur quibusdam suscipit temporibus unde.
18+
Accusantium aliquid corporis cupiditate dolores eum exercitationem illo iure laborum minus nihil numquam odit officiis possimus quas quasi quos similique, temporibus veritatis? Exercitationem, iure magni nulla quo sapiente soluta. Esse?
1019

11-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
20+
## Features
1221

13-
## Build
22+
- ✅ One
23+
- ✅ Two
24+
- ✅ Three
1425

15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
26+
## Table of Contents
1627

17-
## Running unit tests
28+
- [Installation](#installation)
29+
- [Usage](#usage)
30+
- [FAQ](#faq)
1831

19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
32+
## Installation
2033

21-
## Running end-to-end tests
34+
### NPM
2235

23-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
36+
`npm install @ngneat/bind-query-params --save-dev`
2437

25-
## Further help
38+
### Yarn
2639

27-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
40+
`yarn add @ngneat/bind-query-params --dev`
41+
42+
## Usage
43+
44+
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aliquid assumenda atque blanditiis cum delectus eligendi ipsam iste iure, maxime modi molestiae nihil obcaecati odit officiis pariatur quibusdam suscipit temporibus unde.
45+
46+
```ts
47+
function helloWorld() {}
48+
```
49+
50+
## FAQ
51+
52+
## How to ...
53+
54+
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aliquid assumenda atque blanditiis cum delectus eligendi ips
55+
56+
## Contributors ✨
57+
58+
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
59+
60+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
61+
<!-- prettier-ignore-start -->
62+
<!-- markdownlint-disable -->
63+
<!-- markdownlint-enable -->
64+
<!-- prettier-ignore-end -->
65+
66+
<!-- ALL-CONTRIBUTORS-LIST:END -->
67+
68+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
69+
70+
<div>Icons made by <a href="http://www.freepik.com/" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>

0 commit comments

Comments
 (0)
Please sign in to comment.