Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (56 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

68 lines (56 loc) · 3.92 KB

Contributing to Context Vibes CLI

Thank you for considering contributing to Context Vibes! We welcome improvements, bug fixes, and new features that align with the goal of streamlining development workflows and improving AI context generation.

Community Guidelines

We strive to maintain a positive and welcoming environment. All participants are expected to act professionally and respectfully toward others, following the simple guidelines outlined in the README.md's Code of Conduct section.

Getting Started

  1. Prerequisites: Ensure you have Go (1.24 or later recommended) and Git installed and configured correctly. Access to tools like terraform or pulumi might be needed to test specific commands locally.
  2. Fork & Clone: Fork the repository on GitHub (github.com/contextvibes/cli - Adjust URL if needed) and clone your fork locally: 
    # Replace YOUR_USERNAME with your actual GitHub username
git clone https://github.com/YOUR_USERNAME/cli.git contextvibes-cli
cd contextvibes-cli
  3. Build & Run: Ensure you can build and run the binary: 
    # Build the binary
go build -o contextvibes ./cmd/contextvibes/main.go
# Or run directly
go run cmd/contextvibes/main.go --help
    You can also install it to your $GOPATH/bin for easier testing during development: 
    go install ./cmd/contextvibes

Making Changes

  1. Create a Branch: Before making changes, create a new branch from the main branch: 
    git checkout main
git pull origin main # Ensure your main is up-to-date
git checkout -b feature/your-feature-name # Example: feature/add-nodejs-support
# or
git checkout -b fix/issue-description # Example: fix/improve-plan-error-msg
  2. Implement: Make your code changes. Keep changes focused on a single feature or bug fix per branch.
  3. Follow Style: Adhere to standard Go formatting (gofmt) and linting practices. You can use contextvibes format and contextvibes quality to help with this. Use go vet ./... to catch common issues.
  4. Test:
    • Manual: Run the commands you've modified in relevant test projects (e.g., a simple Git repo, a Terraform project, a Go project) to ensure they behave as expected. Use the new contextvibes test command for running automated project tests if applicable.
    • Automated: If adding new functions, especially in internal/, please add corresponding unit tests (_test.go files). Contributions to increase overall test coverage are highly encouraged. Run Go unit tests using: 
      go test ./...
  5. Commit: Commit your changes using clear and descriptive commit messages. Consider following the Conventional Commits specification (e.g., feat: ..., fix: ..., refactor: ..., docs: ...). 
    git add .
git commit -m "feat(plan): Add detection for Rust Cargo.toml"

Submitting a Pull Request

  1. Push: Push your feature or fix branch to your fork on GitHub: 
    git push origin feature/your-feature-name
  2. Open PR: Go to the original contextvibes/cli repository on GitHub. GitHub should automatically detect your pushed branch and prompt you to create a Pull Request.
  3. Describe: Fill out the Pull Request template, clearly describing the problem you're solving and the changes you've made. Link to any relevant issues.
  4. Review: Respond to any feedback or code review comments. The maintainers will review your PR and merge it if it meets the project's standards.

Finding Ways to Contribute

For a detailed list of known bugs, planned refactorings, potential enhancements, and other ideas for contributions, please see our ROADMAP.md. We welcome contributions to items listed there or your own suggestions that align with the project's goals!

Thank you for contributing to Context Vibes!