Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"files": [
"README.md"
],
"imageSize": 100,
"commit": false,
"contributors": [
{
"login": "solkimicreb",
"name": "Miklos Bertalan",
"avatar_url": "https://avatars3.githubusercontent.com/u/6956014?v=4",
"profile": "https://bertalan-miklos.now.sh/",
"contributions": [
"code"
]
},
{
"login": "rolandszoke",
"name": "Roland",
"avatar_url": "https://avatars3.githubusercontent.com/u/14181908?v=4",
"profile": "https://github.com/rolandszoke",
"contributions": [
"code"
]
}
],
"contributorsPerLine": 7,
"projectName": "react-easy-state",
"projectOwner": "RisingStack",
"repoType": "github",
"repoHost": "https://github.com",
"skipCi": true
}
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
README.md
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing

## Issues

Issues are precious to this project.

- **Ideas** are a valuable source of contributions others can make
- **Problems** show where this project is lacking
- With a **question**, you show where contributors can improve the user experience

Thank you for creating them.

## Commits

Your commit messages should follow Angular [commit convention](https://www.conventionalcommits.org/en/v1.0.0-beta.4/). Therefore we are linting your commits with [Husky](https://github.com/typicode/husky), meaning you cannot create a non-conventional commit message. If you squash merge your pull request, please make sure you also follow the commit convention in your squashed commit message.

## Pull Requests

Pull requests are a great way to get your ideas into this repository.
You should be clear which problem you're trying to solve with your contribution.
Every pull request will require an approved review before merging.

## Linters

This project is using [ESLint](https://eslint.org/) for linting and [Prettier](https://prettier.io/) for code formatting. Please follow their standards on contributing. Your code is automatically formatted on saving a file when using [VSCode](https://code.visualstudio.com/) or [Atom](https://atom.io/). [Husky](https://github.com/typicode/husky) ensures that your changes are properly linted before making a commit. If you want to lint manually, you can use `lint` and `lint-fix` npm scripts to lint the source code and `lint-tests` or `lint-tests-fix` to lint the test files.

## Tests

To run our tests use `npm t` script. We are using [Jest](https://jestjs.io/) and [React Testing Library](https://github.com/testing-library/react-testing-library) for testing. Consider creating new test cases when necessary under the `__tests__` folder, we want to keep our test covarage above 90%. Use `.test.js` or `.test.jsx` suffix for test files and `.test.native.js` or `.test.native.jsx` for native tests.
Loading