CONTRIBUTING.md

Contributing to P21 API Documentation

Note: This is unofficial, community-created documentation not affiliated with Epicor Software Corporation.

Thank you for your interest in improving P21 API documentation! This project aims to be the comprehensive resource for Prophet 21 API integration that the community deserves.

Ways to Contribute

1. Report Issues

• Found an error in the docs? Open a bug report
• Something unclear? Request clarification

2. Request Documentation

• Need docs for an API endpoint we haven't covered?
• Have a use case that should be documented?
• Submit a documentation request

3. Share Your Knowledge

• Have working P21 API code? Share it!
• Discovered undocumented behavior? Tell us!
• Submit a contribution

4. Submit Pull Requests

1. Fork the repository
2. Create a branch (git checkout -b feature/new-endpoint-docs)
3. Make your changes
4. Test any code examples
5. Submit a PR

Guidelines

Documentation Standards

• Facts only - No guesses about undocumented behavior
• Verified examples - All code should run without errors
• Real payloads - Include actual API request/response examples
• Note limitations - Document known issues and workarounds

Code Examples

• Use Python with httpx for HTTP calls
• Include error handling
• Add comments explaining P21-specific behavior
• Test against a P21 environment before submitting

What We're Looking For

• Additional API endpoints not yet documented
• Real-world integration examples
• P21 version-specific differences
• Performance tips and best practices
• Error messages and their solutions

Questions?

Use GitHub Discussions for questions and community help.

Recognition

Contributors will be recognized in the project. Thank you for helping the P21 community!