SDK Developer Resources

Contributing to Our SDK

We welcome contributions from the community! Whether it's bug fixes, new features, documentation improvements, or performance enhancements, your efforts help make our SDK better for everyone. This guide outlines the process and best practices for contributing.

Getting Started

Before you start coding, it's a good idea to familiarize yourself with our project.

• Review the Codebase: Explore the SDK's source code to understand its structure and design patterns.
• Read the Contribution Guidelines: This document provides the detailed steps.
• Check Existing Issues: See if your idea or bug fix is already being worked on. You can find our issues on our project repository.

How to Contribute

1. Fork the Repository: Create your own copy of our repository on GitHub.

   git clone https://github.com/your-username/your-sdk-fork.git

2. Create a New Branch: Make sure you're working on a dedicated branch for your changes. Use a descriptive name.

   git checkout -b feature/your-new-feature

   or

   git checkout -b fix/bug-description

3. Make Your Changes: Implement your feature, fix your bug, or improve the documentation. Ensure your code adheres to our coding standards.
4. Write Tests: All new features and bug fixes should be accompanied by appropriate tests. Ensure all existing tests pass.
5. Commit Your Changes: Commit your changes with clear and concise messages.

   git add .
   git commit -m "feat: Add user profile endpoint"

6. Push to Your Fork: Push your branch to your forked repository.

   git push origin feature/your-new-feature

7. Open a Pull Request: Go to our main repository on GitHub and open a new Pull Request (PR) from your branch.
   • Provide a clear title and description for your PR.
   • Explain the problem you're solving and the solution you've implemented.
   • Link to any relevant issues.

Coding Standards and Best Practices

• Language and Style: Follow the established coding conventions for the language (e.g., PEP 8 for Python, standard JavaScript practices).
• Documentation: Ensure all public APIs are documented using standard docstrings or JSDoc.
• Testing: Aim for comprehensive test coverage. If you introduce new functionality, add tests for it. If you fix a bug, add a test that reproduces the bug before your fix.
• Commits: Write atomic commits. Each commit should represent a single logical change.
• Performance: Be mindful of performance implications. If your changes might affect performance, mention it in your PR.

Types of Contributions

• Bug Reports: If you find a bug, please report it via our issue tracker. Provide detailed steps to reproduce the issue, along with environment information.
• Feature Requests: We're always looking for new ideas. You can submit feature requests as issues.
• Code Contributions: Pull requests for bug fixes, new features, and performance improvements are highly valued.
• Documentation: Improvements to our documentation are crucial. Typos, unclear explanations, or missing sections can all be improved.
• Examples: Contributing new or improved code examples can significantly help other developers learn and use the SDK.

Code of Conduct

Please note that all participants in this project are expected to adhere to our Code of Conduct.

Questions?

If you have any questions about contributing, feel free to open an issue or reach out to us on our community forum.