generated from pixelass/react-package-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 8186ddc
Showing
35 changed files
with
9,458 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
last 2 android versions | ||
last 2 edge versions | ||
last 2 chrome versions | ||
last 2 firefox versions | ||
last 2 ios versions | ||
last 2 safari version |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"extends": ["@commitlint/config-conventional"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
indent_style = tab | ||
indent_size = 4 | ||
max_line_length = 100 | ||
end_of_line = lf | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
# trailing spaces in markdown indicate word wrap | ||
[*.md] | ||
trim_trailing_whitespace = false | ||
|
||
|
||
[{*.json,*.md,*.yml,.*rc,.*config}] | ||
indent_style = space | ||
indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
{ | ||
"root": true, | ||
"extends": [ | ||
"typescript", | ||
"eslint:recommended", | ||
"plugin:react/recommended", | ||
"plugin:react/jsx-runtime", | ||
"plugin:prettier/recommended" | ||
], | ||
"env": { | ||
"browser": true, | ||
"es2022": true, | ||
"jest": true, | ||
"node": true | ||
}, | ||
"parserOptions": { | ||
"ecmaFeatures": { | ||
"jsx": true | ||
} | ||
}, | ||
"plugins": ["unicorn", "react-hooks", "import", "jest"], | ||
"ignorePatterns": ["dist", "*.d.ts"], | ||
"rules": { | ||
"import/order": [ | ||
"error", | ||
{ | ||
"alphabetize": { | ||
"order": "asc", | ||
"caseInsensitive": true | ||
}, | ||
"newlines-between": "always" | ||
} | ||
], | ||
"react/jsx-uses-react": "off", | ||
"react/react-in-jsx-scope": "off", | ||
"react/prop-types": "off", | ||
"no-nested-ternary": "error", | ||
"object-curly-spacing": ["error", "always"], | ||
"prettier/prettier": "error", | ||
"arrow-body-style": ["error", "as-needed"] | ||
}, | ||
"overrides": [ | ||
{ | ||
"files": "{**/*,*}.{ts,tsx}", | ||
"rules": { | ||
"import/extensions": [ | ||
"error", | ||
{ | ||
"js": "never", | ||
"jsx": "never", | ||
"ts": "never", | ||
"tsx": "never", | ||
"css": "always", | ||
"json": "always", | ||
"png": "always", | ||
"jpg": "always", | ||
"jpeg": "always", | ||
"svg": "always" | ||
} | ||
], | ||
"react/prop-types": "off", | ||
"unicorn/prefer-module": "off" | ||
} | ||
}, | ||
{ | ||
"files": "types.ts", | ||
"rules": { | ||
"no-unused-vars": "off" | ||
} | ||
}, | ||
{ | ||
"files": "*.test.ts", | ||
"rules": { | ||
"import/no-unassigned-import": "off" | ||
} | ||
}, | ||
{ | ||
"files": "*.config.mjs", | ||
"rules": { | ||
"import/extensions": "off", | ||
"node/file-extension-in-import": "off" | ||
} | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
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, sex characteristics, gender identity | ||
and expression, level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
- The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
- Trolling, insulting/derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or electronic address, without explicit | ||
permission | ||
- Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
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. | ||
|
||
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. | ||
|
||
## Scope | ||
|
||
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. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting | ||
the project team at [email protected]. All complaints will be reviewed and investigated and will | ||
result in a response that is deemed necessary and 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. | ||
|
||
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. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at | ||
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Contributing | ||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue, | ||
email, or any other method with the owners of this repository before making a change. | ||
|
||
Please note we have a code of conduct, please follow it in all your interactions with the project. | ||
|
||
## Pull Request Process | ||
|
||
Ensure any install or build dependencies are removed before the end of the layer when doing a build. | ||
Fork the repository and create a new branch (feature/my-feature) Commit changes following the | ||
"conventional-changelog" rules. Do not modify any versions manually. Don't build new versions. Use | ||
the PULL_REQUEST_TEMPLATE | ||
|
||
## Reporting issues | ||
|
||
Ensure any install or build dependencies are removed before the end of the layer when doing a build. | ||
Create a new issue (bug/some-bug) Always list "yarn version", "node version" Use the ISSUE_TEMPLATE |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
name: Bug Report | ||
description: File a bug report | ||
title: "[Bug]: " | ||
labels: ["bug", "triage"] | ||
assignees: | ||
- octocat | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: input | ||
id: contact | ||
attributes: | ||
label: Contact Details | ||
description: How can we get in touch with you if we need more info? | ||
placeholder: ex. [email protected] | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What happened? | ||
description: Also tell us, what did you expect to happen? | ||
placeholder: Tell us what you see! | ||
value: "A bug happened!" | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: version | ||
attributes: | ||
label: Version | ||
description: What version of our software are you running? | ||
options: | ||
- 1.0.0 (Default) | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: browsers | ||
attributes: | ||
label: What browsers are you seeing the problem on? | ||
multiple: true | ||
options: | ||
- Firefox | ||
- Chrome | ||
- Safari | ||
- Microsoft Edge | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Relevant log output | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
render: shell | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest a feature for this project | ||
labels: enhancement | ||
--- | ||
|
||
<!-- | ||
*********************************** | ||
**** Please add a user story **** | ||
*********************************** | ||
Examples: | ||
As a User | ||
I want to sign in | ||
So that I can access my account | ||
As a Developer | ||
I want a testing setup | ||
So that I can run automated tests | ||
--> | ||
|
||
<!-- | ||
************** | ||
* By users * | ||
************** | ||
--> | ||
|
||
## User Story | ||
|
||
<!-- See: https://cucumber.io/blog/bdd/user-stories-are-not-the-same-as-features/ --> | ||
|
||
```gherkin | ||
As a <user> | ||
I want <feature> | ||
So that <benefit> | ||
``` | ||
|
||
<!-- | ||
********************************************************************************* | ||
**** Everything below this comment will be filled in by repository members **** | ||
********************************************************************************* | ||
--> | ||
|
||
<!-- | ||
****************** | ||
* By designers * | ||
****************** | ||
--> | ||
<!-- | ||
## Wireframe / Design | ||
--> | ||
|
||
<!-- | ||
*********************** | ||
* By product owners * | ||
*********************** | ||
--> | ||
<!-- See: https://cucumber.io/docs/gherkin/reference/ --> | ||
<!-- | ||
## Acceptance Criteria | ||
```gherkin | ||
feature: <feature> | ||
As a <persona> | ||
I want <feature> | ||
So that <benefit> | ||
Scenario: <scenario> | ||
Background | ||
<background> | ||
Given <prerequisite> | ||
When <action> | ||
Then <result> | ||
``` | ||
--> | ||
|
||
<!-- | ||
******************* | ||
* By developers * | ||
******************* | ||
--> | ||
<!-- | ||
## Tasks | ||
- [ ] … | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
## Motivation | ||
|
||
<!-- List motivation and changes here --> | ||
|
||
## Issues closed | ||
|
||
<!-- List closed issues here --> |
Oops, something went wrong.