Skip to content

Update README.md and CONTRIBUTING.md documents #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 4, 2018
Merged

Update README.md and CONTRIBUTING.md documents #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6188a7f
Update README and CONTRIBUTING documents
Jun 4, 2018
7c6890a
Add contribution guideline
Jun 4, 2018
f3353a4
Add contribution guideline for fast-deep-equal updates
Jun 4, 2018
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
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,25 @@ Contributing

Thanks for contributing!

## Before you contribute

This package is a fork of [fast-deep-equal](https://github.com/epoberezkin/fast-deep-equal). This library has added handling for React. Before contributing, _please make sure the issue relates directly to this library and not fast-deep-equals_.

We encourage pull requests concerning:

* React features not handled in this library
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add another bullet for the thing you just did: * Integrating updates from fast-deep-equal

* Integrating updates from fast-deep-equal
* Integrating tests from fast-deep-equal
* Bugs in this library
* New tests for React
* Documentation

Pull requests that should be for [fast-deep-equal](https://github.com/epoberezkin/fast-deep-equal):

* Equality of non-react comparisons
* Performance of non-react comparisons
* Tests for non-react comparisons

## Development

Install the project using `yarn` (which we've standardized on for development):
Expand Down
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,10 @@ $ yarn install
$ yarn run benchmark
```

## fast-deep-equal Versioning

[email protected] tracks [email protected]

## License

[MIT](https://github.com/FormidableLabs/react-fast-compare/blob/readme/LICENSE)
Expand Down