Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Bug Report
description: Report a bug or unexpected behavior
labels: ["bug"]
body:
- type: textarea
id: description
attributes:
label: Description
description: What happened?
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Commands or steps to reproduce the issue.
placeholder: |
1. Run `esq ...`
2. ...
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
validations:
required: true

- type: textarea
id: version
attributes:
label: Environment
description: Output of `esq --version`, OS, and Elasticsearch version.
placeholder: |
esq version: v0.1.0
OS: macOS 15.2 / Ubuntu 24.04 / Windows 11
Elasticsearch: 8.x
validations:
required: true
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Feature Request
description: Suggest a new feature or improvement
labels: ["enhancement"]
body:
- type: textarea
id: problem
attributes:
label: Problem
description: What problem does this solve? What are you trying to do?
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: How should this work?
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Any workarounds or alternative approaches you've considered.
validations:
required: false
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Summary

<!-- What does this PR do? -->

## Changes

<!-- List the specific changes made. -->
-

## Testing

- [ ] `go test -race ./...` passes
- [ ] `golangci-lint run` passes
- [ ] Tested manually against an Elasticsearch cluster (if applicable)
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Thanks for your interest in contributing! Here's how to get started.
```bash
git clone https://github.com/enthus-appdev/esq-cli.git
cd esq-cli
make build # Build the binary
make test # Run tests
make lint # Run goimports + golangci-lint
go build ./cmd/esq # Build the binary
go test -race ./... # Run tests
golangci-lint run # Lint
```

Requires Go 1.24+ and [golangci-lint](https://golangci-lint.run/).
Expand All @@ -18,7 +18,7 @@ Requires Go 1.24+ and [golangci-lint](https://golangci-lint.run/).

1. Fork the repository and create a feature branch from `main`
2. Write your code and add tests where appropriate
3. Run `make lint && make test` to ensure all checks pass
3. Run `golangci-lint run && go test -race ./...` to ensure all checks pass
4. Commit with a clear message describing the change
5. Open a pull request against `main`

Expand Down
26 changes: 0 additions & 26 deletions Makefile

This file was deleted.

15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,10 @@ Query and inspect Elasticsearch clusters across environments from the command li
Requires Go 1.24+.

```bash
# Via go install
go install github.com/enthus-appdev/esq-cli/cmd/esq@latest

# Or clone and build
git clone https://github.com/enthus-appdev/esq-cli.git
cd esq-cli
make install # builds and copies to ~/bin/
```

Ensure `~/go/bin` or `~/bin` is in your `PATH`.
Ensure `~/go/bin` is in your `PATH`.

## Setup

Expand Down Expand Up @@ -109,10 +103,9 @@ esq completion fish > ~/.config/fish/completions/esq.fish
## Development

```bash
make build # Build to bin/esq
make install # Build + copy to ~/bin/
make lint # goimports + golangci-lint
make test # Run tests
go build ./cmd/esq # Build the binary
go test -race ./... # Run tests
golangci-lint run # Lint
```

## License
Expand Down