We love your input! We want to make contributing to PlantPal as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
- Fork the repo and create your branch from
main - If you've added code that should be tested, add tests
- If you've changed APIs, update the documentation
- Ensure the test suite passes
- Make sure your code lints
- Issue that pull request!
- Update the README.md with details of changes to the interface
- Update the requirements.txt with any new dependencies
- Increase the version numbers in any example files and the README.md to the new version
- The PR will be merged once you have the sign-off of two other developers
- React components
- Mobile app features
- UI/UX improvements
- Accessibility enhancements
- API endpoints
- Database optimizations
- Caching improvements
- Authentication features
- Model improvements
- Dataset contributions
- Training pipeline optimizations
- Mobile model optimization
- Technical documentation
- User guides
- API documentation
- Code comments
Contributors can earn ROXN tokens for their contributions. The reward amount depends on:
- Task complexity
- Impact of contribution
- Code quality
- Documentation quality
- Follow PEP 8 guidelines
- Use type hints
- Write docstrings for functions and classes
- Maximum line length of 88 characters
- Use ESLint configuration
- Follow Prettier formatting
- Write JSDoc comments for functions
- Use TypeScript where possible
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
By contributing, you agree that your contributions will be licensed under its MIT License.