Skip to content

Commit 7b7192a

Browse files
NetanelBasalNetanelBasal
committed
chore: 🤖 add repo files
1 parent 28292e2 commit 7b7192a

16 files changed

+11471
-4704
lines changed

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

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Bug Report
2+
description: Report a bug in the Falso Library
3+
4+
body:
5+
- type: dropdown
6+
id: is-regression
7+
attributes:
8+
label: Is this a regression?
9+
options:
10+
- 'Yes'
11+
- 'No'
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: description
17+
attributes:
18+
label: Description
19+
validations:
20+
required: true
21+
22+
- type: input
23+
id: reproduction
24+
attributes:
25+
label: Please provide a link to a minimal reproduction of the bug
26+
27+
- type: textarea
28+
id: exception-or-error
29+
attributes:
30+
label: Please provide the exception or error you saw
31+
render: true
32+
33+
- type: textarea
34+
id: environment
35+
attributes:
36+
label: Please provide the environment you discovered this bug in
37+
render: true
38+
39+
- type: textarea
40+
id: other
41+
attributes:
42+
label: Anything else?
43+
44+
- type: dropdown
45+
id: contribute
46+
attributes:
47+
label: Do you want to create a pull request?
48+
options:
49+
- 'Yes'
50+
- 'No'
51+
validations:
52+
required: true

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

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: 'Feature Request'
2+
description: Suggest a feature for Falso Library
3+
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
validations:
10+
required: true
11+
12+
- type: textarea
13+
id: proposed-solution
14+
attributes:
15+
label: Proposed solution
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: alternatives-considered
21+
attributes:
22+
label: Alternatives considered
23+
validations:
24+
required: true
25+
26+
- type: dropdown
27+
id: contribute
28+
attributes:
29+
label: Do you want to create a pull request?
30+
options:
31+
- 'Yes'
32+
- 'No'
33+
validations:
34+
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/falso/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/falso/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

‎.husky/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_

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

‎.husky/pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
. "$(dirname "$0")/_/husky.sh"
3+
4+
npm test

‎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

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

‎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

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
<p align="center">
2+
<img width="20%" height="20%" src="logo.png">
3+
</p>
4+
15
## Create new file
26

3-
`yarn c firstName`
7+
`yarn f firstName`
8+
9+
10+
11+
<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

+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: [],
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+
};

‎logo.png

37.2 KB
Loading

0 commit comments

Comments
 (0)