Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.14 KB

Contributing to LogTide Kotlin SDK

Thank you for your interest in contributing!

Development Setup

  1. Clone the repository:
git clone https://github.com/logtide-dev/logtide-sdk-kotlin.git
cd logtide-sdk-kotlin
  1. Build the project:
./gradlew build
  1. Run tests:
./gradlew test

Code Style

  • Follow Kotlin coding conventions
  • Use meaningful variable and function names
  • Add KDoc comments for public APIs
  • Keep functions focused and concise

Testing

  • Write unit tests for all new features
  • Ensure all tests pass before submitting PR
  • Aim for high code coverage

Pull Request Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Reporting Issues

  • Use the GitHub issue tracker
  • Provide clear description and reproduction steps
  • Include relevant logs and error messages

Questions?

Feel free to open an issue for any questions or discussions!