Contributing to PARC
We welcome contributions from the community to help improve PARC. Whether you’re fixing bugs, adding new features, improving documentation, or sharing feedback, your contributions are valued.Reporting Issues
If you encounter bugs or have suggestions for improvements:Check Existing Issues
Search the GitHub Issues to see if your issue has already been reported.
Submitting Improvements
Code Contributions
To contribute code to PARC:- Fork the Repository: Create your own fork of the PARC repository
- Create a Branch: Make your changes in a feature branch
- Make Your Changes: Implement your improvements or fixes
- Test Thoroughly: Ensure your changes work and don’t break existing functionality
- Submit a Pull Request: Open a PR with a clear description of your changes
Documentation Improvements
Documentation contributions are equally important:- Fix typos or clarify confusing sections
- Add examples or tutorials
- Improve code comments
- Expand the guides and references
Development Guidelines
Code Quality
- Follow the existing code style and conventions
- Write clear, descriptive commit messages
- Include comments for complex logic
- Keep changes focused and atomic
Testing
Before submitting:- Test your changes in a clean environment
- Verify compatibility with the supported Python version (3.8.20)
- Ensure no regressions in existing functionality
Community
PARC is an academic research project. For questions or discussions:- Open a GitHub issue for bugs or feature requests
- Check the project page for additional resources
- Review the Core Concepts and Guides for implementation details
License
By contributing to PARC, you agree that your contributions will be licensed under the same license as the project (MIT License).For major changes or new features, we recommend opening an issue first to discuss the proposed changes with the maintainers.