Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.93 KB

contributing.md

File metadata and controls

37 lines (25 loc) · 1.93 KB

Contributing

Getting started

DevTools is a React app built with webpack. Here are the steps for getting started:

git clone git@github.com:RecordReplay/devtools.git

nvm use

cp .env.sample .env

yarn install
yarn dev

Once you see Compiled successfully in your terminal, open your browser and go to this link.

If you have questions, you can always ask in our #development Discord channel.

Contributing code

💡 WARNING: Not following these rules will result in your PR being closed

Contributing to Open Source can be challenging. Mistakes –even small ones– can prevent a change from being accepted. We ask that you follow the rules below to make the process as smooth as possible!

  1. Before posting a PR, please run all Lint, typecheck, and test actions:
    • Run TypeScript (npm run typecheck) and Lint (npm run lint) to check for errors and formatting issues.
    • Run unit tests (npm run test) to check if change broke other code.
    • Add new unit tests for your code and make sure that it also passes. (This helps the reviewer. It also verifies that your code works correctly now and does not get broken by future changes.)
  2. Open a PR on GitHub with your changes. The PR description must include the following:
    • Link to the GitHub issue you are fixing (and any other relevant links)
    • Show how your change effects the UI/UX. (Screenshots, short Loom videos and Replays are good ways to show changes.)
  3. (Optionally) ask someone to review your PR by mentioning their GitHub username.
    • Please only mention someone if they opened the GitHub issue your PR is related to, or if they actively commented on it and seem to have an understanding of the topic.
    • Please be patient as it may take several days for a PR to be reviewed.