Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (19 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 1.41 KB

Contributing to FastFetch

First off, thank you for considering contributing to FastFetch. It's people like you that make FastFetch such a robust and powerful tool for developers.

1. Where do I go from here?

If you've noticed a bug or have a feature request, make one! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.

2. Fork & branch

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Navigate to the project directory: cd FastFetch-API-Fetch-Enhancer
  4. Create a new branch: git checkout -b my-awesome-new-feature

3. Setup the project and tests

  1. Run npm install to install dependencies.
  2. Run npm test to run the Jest test suite. Please ensure that all tests pass locally before pushing your code.
  3. If you add a new feature, please add test coverage for it into __tests__/demo.test.ts.

4. Push your changes

  • Push your branch to your fork: git push -u origin my-awesome-new-feature
  • Go to GitHub and submit a Pull Request to the master branch.
  • Wait for the GitHub Actions CI pipeline to validate your contribution.

5. Architectural Philosophies

FastFetch aims to be lightweight. We use cross-fetch to maintain isomorphic behaviors. When writing logic, default to utilizing the existing Koa-style middlewares (api.use()) over writing direct native XMLHttpRequest manipulation logic.