Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 963 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 963 Bytes
Raw

Contributing

Thanks for being willing to contribute!

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Project setup

  1. Fork and clone the repo
  2. Define your type in src/types/index.ts
  3. Make your changes
  4. Create a branch for your PR
  5. Make a PR

Some Tips

  • Define every type, even simple ones.

  • Capitalize your types.

  • Update the Documentation, when you update the code.

Dependencies

We are planning to keep this package without dependencies. If you need a dependency, if possible, create it as a interceptor, and publish it as its own package.

Help needed

Please open issues, if you encounter any issues.

Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!