First off, thank you for considering contributing to Pericles! It's people like you that make Pericles such a great tool.
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
- Open a new issue detailing your enhancement.
- Clearly describe the use case and your reason for proposing the enhancement.
- Fork the repo and create your branch from main.
- If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
- To set up the development environment, ensure you have pnpm and turbo installed.
- Clone the repo and run pnpm install.
- To build for development, run npm run dev.
- Migrate from manifest v2 to v3.
- Migrate to Typescript. Please refer to our roadmap on GitHub for more details.