Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (50 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

71 lines (50 loc) · 2.67 KB

Contibuting guide 💪

Thank you for your willingness to contribute and even taking your time to read this guide.

Documentation 📚

Documentation is hosted in a separate repository, that acts as my portfolio/home page.

Code 🧑‍💻

To provide a code contribution, please create a pull request and fill out the pull request template.

Pre-requisites 👀

  • pnpm (PR's with incompatible lockfile due to different node package manager will not be accepted)

Contribution workflow 📝

After cloning the repository and doing pnpm install you're free to do any changes as deemed necessary.

  1. Add individual changes (please split bigger changes into smaller chunks, instead of single giant commit)
  2. Run pnpm cz to trigger the interactive cli to make sure your commits match the project rules
  3. Push your changes - This will trigger automatic linting and test check to make sure your PR didn't break anything

You do not need to bump any versions or deploy anything. This will be done automatically in the next release.

Acceptence criteria ✅

  1. Adding any additional dependencies to the core package will result in closing the PR (unless a good reason is provided)
  2. Pull requests not adhering to the pull request template will be closed
  3. Disabling eslint / ts rules must always be accompanied with a good reason as to why the rule is being disabled.

Additonal information ℹ️

Here are some useful commands (these will trigger and cache in all packages automatically, via turborepo. Consider these commands as global unless stated otherwise)

Command Description
pnpm install Installs dependencies
pnpm clean Removes node_modules and pnpm-lock.yaml
pnpm lint Runs eslint
pnpm format Runs prettier
pnpm test Runs vitest

Here's the project structure (just the most important parts)

📁 .github # CI/CD workflows and templates
📁 packages
  📁 core # the main @hulla/api package
  📁 request # @hulla/api-request
  📁 query # @hulla/api-query
  📁 swr # @hulla/api-swr
⎗ .eslintrc # shared eslint configuration
⎗ .prettierrc # shared prettier configuration
⎗ tsconfig.json # shared typescript configuration
⎗ turbo.json # turborepo configuration

Each package has a following structure

📁 src # source code that's transpited
  ⎗ index.ts # main export file
  ⎗ ... # other files
📁 tests
  ⎗ {name}.test.ts # matching test coverage for src file name