How to contribute

Thank you for your interest in contributing to cligen! We welcome all contributions, from bug reports and documentation updates to new features and scaffolds.

Getting Started link

Prerequisites link

To build and test cligen locally, you’ll need:

• Go: version 1.25 or higher.
• Make: for running build and test commands.
• golangci-lint: for linting (optional but recommended).

Fork and Clone link

1. Fork the repository on GitHub: twinsnes/cligen.
2. Clone your fork locally:

     git clone https://github.com/YOUR_USERNAME/cligen.git
   cd cligen
     

Development Workflow link

Creating a Branch link

Always create a new branch for your changes:

  git checkout -b feature/your-feature-name
# or
git checkout -b fix/bug-description
  

Making Changes link

cligen is structured as follows:

• cmd/: CLI command definitions.
• internal/: Core logic for generation, prompting, and configuration.
• templates/: The actual scaffolds used to generate new projects.

If you are modifying templates, refer to the Templates Overview for more details on the structure.

Running Tests and Linting link

Before submitting your changes, ensure everything is working correctly and follows the project’s style.

• Linting: Run the linter to check for style issues.

    make lint
    

• Running Tests: Execute the test suite.

    make test
    

• Building: Build the binary locally to test the CLI manually.

    make build
  ./dist/cligen --help
    

Submitting a Pull Request link

1. Commit your changes using clear and descriptive commit messages. We encourage Conventional Commits.
2. Push your branch to your fork on GitHub.
3. Open a Pull Request against the main branch of the original repository.
4. Provide a clear description of your changes and link to any related issues.

Code of Conduct link

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.