Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (20 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.15 KB

Contributing to IngestKit

Thank you for your interest in contributing to IngestKit! We welcome contributions from the community to help make this project better.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Set up your development environment by following the Development Guide.

Development Workflow

We use a standard GitHub Pull Request workflow:

  1. Create a new branch for your feature or fix: git checkout -b feature/my-awesome-feature.
  2. Make your changes.
  3. Run tests to ensure no regressions: make test.
  4. Commit your changes with clear messages.
  5. Push to your fork and submit a Pull Request.

Code Style

  • Go: We follow standard Go conventions. Run make fmt and make lint before committing.
  • Documentation: Ensure documentation is updated if you change behavior.

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce for bugs.

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.