@antoinette-agency/sofetch
Version:
An opinionated Fetch wrapper for JSON APIs
42 lines (24 loc) • 1.25 kB
Markdown
# Contributing to `soFetch`
We want to ensure that `soFetch` continues to grow and evolve. We would like to encourage everyone to help and support this library by contributing.
## Code contributions
Here is a quick guide to doing code contributions to the library.
1. Fork and clone the repo to your local machine `git clone https://github.com/YOUR_GITHUB_USERNAME/so-fetch.git`
2. Create a new branch from `master` with a meaningful name for a new feature or an issue you want to work on: `git checkout -b meaningful-branch-name`
3. Install packages by running:
```shellscript
npm install
```
4. If you've added a code that should be tested, ensure the test suite still passes.
```shellscript
npm test
```
5. Try to write some meaningful tests to cover your new code.
6. Ensure build passes.
```shellscript
npm build
```
7. Push your branch: `git push -u origin meaningful-branch-name`
8. Submit a pull request to the upstream so-fetch repository.
9. Add a descriptive title and a concise description of your changes.
## License
By contributing your code to the react-hook-form GitHub repository, you agree to license your contribution under the AGPL3.0 license.