Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (29 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 2.3 KB
Raw

🤝 Contributing to UVerify SDKs

Thank you for your interest in contributing to the UVerify SDKs! We value your input and collaboration. Please follow these guidelines to ensure a smooth contribution process.

📝 Guidelines

  1. Open an Issue First Before starting work on a feature or task, please open an issue in the repository to align with the project goals. This helps avoid duplicate efforts and ensures your contribution fits the project's vision.

  2. Semantic Commits Use semantic commit messages to maintain a clean and meaningful commit history. Examples:

    • feat: add support for new metadata field
    • fix: resolve incorrect error type on 404 response
    • docs: update README with new feature details
    • chore: update dependencies to latest versions

  3. Sign the CLA All contributors must sign the Contributor License Agreement (CLA) before their contributions can be merged. This ensures that the project remains open and accessible to everyone.

    • You can review the CLA here in the repository.
    • To sign the CLA, visit CLA Assistant. The bot will guide you through the signing process when you open a pull request.

  4. Pull Requests

    • Fork the repository and create a new branch for your changes.
    • Ensure your code is well-documented and follows the project's coding standards.
    • Submit a pull request with a clear description of your changes.

  5. Testing Please test your changes thoroughly before submitting a pull request. Include any relevant test cases to ensure the stability of the project.

    • TypeScript SDK: uses Vitest — run npm test inside ./typescript.
    • Python SDK: uses pytest — run pytest inside ./python.
    • Java SDK: uses JUnit 5 — run mvn test inside ./java.

💡 Feature Requests

If you have an idea for a new feature, please open an issue and describe your proposal in detail. We encourage collaboration and will work with you to refine your idea.

📧 Need Help?

If you have any questions or need assistance, feel free to reach out to us at hello@uverify.io.

Thank you for contributing to UVerify! 💙