Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (39 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

50 lines (39 loc) · 1.86 KB
Raw

Contributing to {{ PROJECT_NAME }}

First off, thanks for taking the time to contribute! 🎉

Contributing Guidelines

  1. Follow the 'Getting Started' instructions in the README

  2. Create a new branch for your changes:

git checkout -b feature/your-feature-name

  1. Make your changes locally:

    • Follow the setup instructions under Getting Started in the README to set up the dev environment

  2. Run the tests, lint, and production build:

npm test
npm run lint
npm run build

Use Jest with next/jest for all new and existing automated tests. Put tests under tests/ using .test.js, .test.jsx, .test.ts, or .test.tsx filenames. Use Jest mocks for external services and React Testing Library for component interactions. Do not add custom TypeScript/module loaders or another test runner. Use npm run test:watch while developing and npm run test:coverage for reports.

  • if there are any build errors, they'll be listed in the terminal, please fix them. If everything builds fine, you're good to go (warnings are fine, but errors must be addressed)
  1. Commit your changes:
  • Make sure to add/commit ONLY the files that actually relate to the PR: do NOT do git add ., as there are several files that are different from prod so that localhost works properly (like firebaseAdmin, firebaseConfig, everything in the Prisma folder, etc.) so you don't want to commit these to prod
git add [files_you_modified]
git commit -m "Description of your changes"
  1. Push your branch to your fork:
git push origin feature/your-feature-name

  1. Create a Pull Request (PR):

    • Go to the original repository's GitHub page.
    • Click the "Pull Request" tab.
    • Select your branch and submit the PR.

  2. Wait for Review:

    • A maintainer will review your PR.
    • Make any requested changes and update the PR.