Contributing to Netshoot

Contributions are welcome! Whether it's adding a new tool, improving documentation, or fixing a bug, your help is appreciated.

Adding a New Tool

If you would like to add a new package or tool to Netshoot, please follow these steps:

Open an Issue: Before starting work, please open a GitHub issue to discuss the proposed tool. In the issue, include a rationale explaining why the tool would be a useful addition to Netshoot. > Note: If the functionality of the proposed tool is already well-covered by an existing tool in the image, the change may not be accepted to keep the image size manageable.
Fork and Clone: Fork the repository and create a new branch for your changes.
Modify the Build:
- For Alpine Packages: If the tool is available in the Alpine package repositories, add it to the apk add list in the Dockerfile.
- For External Binaries: If the tool needs to be built from source or downloaded as a binary, update the build/fetch_binaries.sh script. Please leverage the multi-stage build process to keep the final image clean. Ensure your script handles both amd64 and arm64 architectures if the tool supports them.
Update Documentation:
- Add the new package to the list of included packages in the README.md file.
- Add a new section under "Sample Use-cases" in the README.md to demonstrate how to use the new tool, including a brief description and a code example.
Submit a Pull Request:
- Push your changes to your fork and open a pull request against the master branch of nicolaka/netshoot.
- The CI pipeline will automatically run, performing a multi-platform build to verify that your changes work for both amd64 and arm64. Please ensure this check passes.

To test your changes locally, you can build the Docker image using the provided Makefile.