Contributing to cmdperf

April 19, 2025 ยท View on GitHub

Thank you for considering contributing to cmdperf! We appreciate any help you can offer, whether it's code, documentation, bug reports, or feedback.

Getting Started

  1. Prerequisites: Ensure you have Go installed (check go.mod for the required version).
  2. Fork & Clone: Fork the repository and clone your fork locally.
  3. Build: Run make build to build the project.
  4. Test: Run make test to execute the test suite.

Making Changes (Code Contributions)

  1. Create a new branch for your changes.
  2. Make your modifications.
  3. Ensure tests pass (make test).
  4. Commit your changes with a clear message.
  5. Push your branch to your fork.

Submitting Contributions

  • Issues (Bugs, Features, Feedback): We highly welcome issue reports! Please open an issue on the main repository detailing any bugs you find, feature ideas you have, or general feedback you'd like to share.
  • Pull Requests (Code/Docs): For code or documentation changes, open a pull request from your fork's branch to the main repository's main branch. Briefly describe the changes you've made.

We aim for a simple and effective contribution process. Thanks again for your interest!