Thank you for your interest in contributing to Kube-NetLag! 🎉
We welcome contributions from everyone, whether it's reporting an issue, improving documentation, or adding new features.
We accept issues, pull requests, and discussions to improve Kube-NetLag.
Here’s how you can contribute:
If you find a bug, please:
- Check existing issues to avoid duplicates.
- Open a new issue with:
- A clear title describing the issue.
- Steps to reproduce the bug.
- Expected vs. actual behavior.
- Logs or error messages (if applicable).
📌 Open an issue here: GitHub Issues
- Fork the repository and create a new branch:
git checkout -b feature/your-feature-name
- Make your changes and commit them with a descriptive commit message.
git commit -m "feat: Add latency histogram support" - Push your branch to GitHub:
git push origin feature/your-feature-name
- Open a Pull Request
- Describe your changes.
- Link related issues (if applicable).
- Tag relevant maintainers for review.
📌 Open a PR here: GitHub Pull Requests
Want a new feature? Open an issue with:
- A clear use case for the feature.
- Any alternatives you considered.
- How it aligns with Kube-NetLag’s goals.
To ensure high-quality contributions, follow these best practices:
- Follow Go coding conventions.
- Use meaningful variable names.
- Format your code with:
go fmt ./..
- Put Kubernetes-related code in
/k8s. - Prometheus metrics go in
/promMetrics. - Network performance logic stays in
/netperf.
To set up Kube-NetLag for development:
- Clone the repository:
git clone https://github.com/AposLaz/kube-netlag.git cd kube-netlag - Intall dependencies:
go mod tidy
- Run the application:
go run .
We follow the Be respectful and inclusive to all community members.
By contributing, you agree that your code will be licensed under the Apache 2.0 License. Read the full license: LICENSE
- Ask a question in Discussions.
- Report a security issue via GitHub Security Advisories.