Thank you for considering contributing to KPM! We welcome contributions in various forms, including bug reports, feature requests, code contributions, and documentation improvements. Please read through this guide to get started.
KPM is the KCL package manager integrated with the kcl mod command. This document outlines the process to contribute to KPM and helps ensure that the community remains welcoming and productive.
Please read and follow our Code of Conduct to ensure a welcoming environment for all contributors.
If you find a bug, please open an issue and provide as much detail as possible. Include steps to reproduce the bug, your environment details, and any relevant logs.
We welcome suggestions for new features or improvements! Please open an issue to discuss your ideas before implementing them to ensure they align with the project’s goals.
For comprehensive instructions on how to contribute, including best practices and additional resources, please refer to the official contribution guide here.
- Fork the KPM repository on GitHub.
- Clone your forked repository to your local machine:
git clone https://github.com/your-username/kpm.git cd kpm
- Ensure you have Go installed.
- Install dependencies:
go mod tidy - Build the project:
make build
- Run the built executable:
./kpm - To see available commands and options, use:
./kpm --help
- Create a new branch for your changes:
git checkout -b my-feature - Make your changes and commit them with a clear and concise commit message.
- Push your changes to your fork:
git push origin my-feature - Open a pull request on the main repository.