First off, thank you for considering contributing to HIPPAGuard! Every contribution helps make HIPPAGuard better.
- Code of Conduct
- Getting Started
- Development Process
- Pull Request Guidelines
- Style Guide
- Testing
- Security
- Documentation
- Community
By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.
- Fork the repository
- Clone the repository
- Install dependencies
- Create a branch
- Write code following style guide
- Add tests for new features
- Ensure all tests pass
- Update documentation if needed
- Submit pull request
- Follow Conventional Commits
- Keep PRs focused on single issue
- Write meaningful PR description
- Link relevant issues
- Use TypeScript strict mode
- Define proper interfaces
- Document public APIs
- Use meaningful names
- Use functional components
- Implement proper prop types
- Handle loading/error states
- Clean up side effects
Required tests:
- Unit tests for components
- Integration tests for forms
- Security tests for encryption
- Edge cases coverage
- Accessibility tests
Security is critical:
- Use SecurityContext for encryption
- Never store unencrypted PHI/PII
- Test encryption thoroughly
- Clear sensitive data
- Follow HIPAA guidelines
Update docs for:
- New features
- API changes
- Security considerations
- Examples
Get help:
- GitHub Issues
- Discussions
- Email: support@hippaguard.com
By contributing, you agree that your contributions will be licensed under MIT License.