First, thank you for contributing to DIM! We're a community-driven project and we appreciate improvements, large and small.
Here are some tips to make sure your Pull Request (PR) can be merged smoothly:
- If you want to add a feature or make some change to DIM, consider filing an issue describing your idea first. This will give the DIM community a chance to discuss the idea, offer suggestions and pointers, and make sure what you're thinking of fits with the style and direction of DIM. If you want a more free-form chat, join our Discord.
- Resist the temptation to change more than one thing in your PR. Keeping PRs focused on a single change makes them much easier to review and accept. If you want to change multiple things, or clean up/refactor the code, make a new branch and submit those changes as a separate PR.
- All of our code is written in TypeScript and uses React to build UI components.
- Be sure to run
pnpm fix
before submitting your PR - it'll catch most style problems and make things much easier to merge. - Don't forget to add a description of your change to docs/CHANGELOG.md so it'll be included in the release notes!
Note: It's often easier to use a package manager like Homebrew for Mac, or Chocolatey for Windows, and install the prerequisites through them.
- Homebrew:
brew install git nodejs corepack visual-studio-code
- Chocolatey:
choco install git nodejs-lts corepack vscode