Skip to content
Open
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
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/cli.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: ⚡ zCLI
description: Report any issues or suggest improvements for our cli.
body:
- type: markdown
attributes:
value: |
# Hello 👋

Thank you for taking the time to report an issue or suggest an improvement. Please complete the sections below to help the Zerops team understand and address your feedback quickly.

Useful links:

- [Contribution Guidelines](https://github.com/zeropsio/zcli/blob/main/CONTRIBUTING.md)
- [Documentation](https://docs.zerops.io/)
- [Discord Server](https://discord.gg/3yZknaRhxK)
- type: checkboxes
attributes:
label: Preliminary Checks
description: Please review and check each box before submitting.
options:
- label: "I have searched for similar issues: https://github.com/zeropsio/zcli/issues"
required: true
- type: textarea
validations:
required: true
attributes:
label: Issue Summary
description: |
Please describe the issue or improvement you'd like to report.
- type: textarea
validations:
required: false
attributes:
label: Suggested Solution
description: If you have ideas for how this issue could be fixed or improved, outline the steps below.
value: |
1.
2.
3.
- type: checkboxes
attributes:
label: Would you like to help fix this issue?
description: If you're interested in contributing a solution, check the box below.
options:
- label: "I would like to work on this"
required: false
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: 💁 Support
url: https://discord.gg/xxzmJSDKPT
about: 'This issue tracker is not for support questions. Join us on Discord for assistance!'
- name: 📘 Documentation
url: https://github.com/zeropsio/zcli
about: File an issue or make an improvement to our cli.
- name: 💡 Share Your Thoughts with Us - New Features, Improvements, and Questions
url: https://github.com/zeropsio/community/discussions
about: Propose and discuss future improvements to Zerops
42 changes: 41 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
## Contributing Guide

work in progress
**Note**: Please follow conventional commits specifications.

Before submitting a pull request, ensure that you check for any existing PRs related to your changes. If one exists, try to collaborate if it's work in progress.


- Test

```
make test
```

- Lint

```
make lint
```

### Platform-Specific Build Commands

- Windows

```
make windows-amd
```

- MacOS

```
make linux-amd
```

```
make darwin-arm
```

- Linux

```
make linux-arm
```

19 changes: 12 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,33 @@ define helpMessage
possible values:
test
lint
build-for-windows-amd
build-for-linux-amd
build-for-darwin-arm
windows-amd
linux-amd
darwin-arm
darwin-amd
endef
export helpMessage

help:
@echo "$$helpMessage"

test:
go test -v ./cmd/... ./src/...
go test -v ./cmd/... ./src/...

lint:
GOOS=darwin GOARCH=arm64 gomodrun golangci-lint run ./cmd/... ./src/... --verbose
GOOS=darwin GOARCH=amd64 gomodrun golangci-lint run ./cmd/... ./src/... --verbose
GOOS=linux GOARCH=amd64 gomodrun golangci-lint run ./cmd/... ./src/... --verbose
GOOS=windows GOARCH=amd64 gomodrun golangci-lint run ./cmd/... ./src/... --verbose

build-for-windows-amd:
windows-amd:
GOOS=windows GOARCH=amd64 go build -o bin/zcli.exe cmd/zcli/main.go

build-for-linux-amd:
linux-amd:
GOOS=linux GOARCH=amd64 go build -o bin/zcli cmd/zcli/main.go

build-for-darwin-arm:
darwin-arm:
GOOS=darwin GOARCH=arm64 go build -o bin/zcli cmd/zcli/main.go

darwin-amd:
GOOS=darwin GOARCH=amd64 go build -o bin/zcli cmd/zcli/main.go