Contributing to monkeytype-readme
Thank you for stopping by. monkeytype-readme welcomes and appreciates your contribution
Before opening a new issue, first search for existing issues to avoid duplications.
When you start working on an issue, make sure you are asked to be assigned to it.
Please include as much details as possible:
- steps to reproduce,
- a github repo that has enough setup to reproduce the bug would be nice,
- screenshots.
If you have an idea and don't know where to start yet, consider opening a discussion first.
If you have a PR ready as your proposed implementation, you can create an issue and a PR that references it.
Each pull request should reference an open issue unless the change is very something simple such as a typo.
- Commit message should follow the Conventional Commits specification, this will enable semantic-release to automate the workflow properly.
- Code should be formatted with prettier and linted with eslint. They are already integrated into the codebase. See package.json for relevant scripts. There might also exist extensions for your editor that further enhance the experience with these tools.
This repo uses pnpm. After forking and/or cloning the repo, a typical workflow is
pnpm install
pnpm build
pnpm testSee package.json for more details