First off, thank you for considering contributing to this project! Your help is greatly appreciated.
If you find a bug, please make sure to:
- Check existing issues: See if the bug has already been reported.
- Open a new issue: If not, please open a new issue. 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.
If you have an idea for an enhancement, please open an issue with a clear title and description of the enhancement you would like to see.
- Fork the repo and create your branch from
master. - Set up the development environment: This is a monorepo using Yarn Workspaces. Run
yarn installat the root of the project to install all dependencies. - Make your changes.
- Ensure the test suite passes: Run
yarn testin the specific workspace you are working on (e.g.,cd phantom-api-backend && yarn test). To run all tests for the entire project, you can use a command likeyarn workspaces foreach run test. - Submit a pull request to the
mainbranch.
Please note that this project follows a code of conduct. Please be respectful in all your interactions.