Thank you for your interest in contributing! Your help makes this SDK better for everyone.
- Fork the repository and create your branch from
main. - Open an issue to discuss your proposed change before submitting a pull request (PR).
- Write clear, descriptive commit messages.
- Add or update tests for any new features or bug fixes.
- Update documentation if your change affects usage or public APIs.
- Follow code style (use standard Java formatting and conventions).
- Keep pull requests focused and small. Large or unrelated changes may be rejected or require splitting.
- Ensure all tests pass before submitting your PR.
- Use Java 21 features where appropriate.
- Use 4 spaces for indentation.
- Use meaningful variable and method names.
- Add Javadoc for public classes and methods.
- Use feature branches for new features:
feature/your-feature-name - Use fix branches for bug fixes:
fix/your-bug-fix
- Reference related issues in your PR description (e.g.,
Closes #12). - Describe what your PR changes and why.
- Wait for code review and address any requested changes.
- Search for existing issues before opening a new one.
- Provide as much detail as possible (steps to reproduce, logs, screenshots, etc.).
Be respectful and inclusive. Harassment or discrimination of any kind will not be tolerated.
Thank you for helping improve the Fapshi Java SDK!