From 7547968ce34ae3dda0f231967dfd2e90b307fca2 Mon Sep 17 00:00:00 2001 From: Arjun Aditya Date: Fri, 11 Oct 2024 20:27:28 +0530 Subject: [PATCH 1/6] feat: add issue template + config --- .github/ISSUE_TEMPLATE/cli.yml | 46 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 ++++++++ 2 files changed, 57 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/cli.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/cli.yml b/.github/ISSUE_TEMPLATE/cli.yml new file mode 100644 index 00000000..57b107dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cli.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..110c8aae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 From cde04db064774d12f88746e31fe21a2e48ecd1ba Mon Sep 17 00:00:00 2001 From: Arjun Aditya Date: Fri, 11 Oct 2024 20:51:56 +0530 Subject: [PATCH 2/6] Update Makefile --- Makefile | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 720b0ed4..d550e033 100644 --- a/Makefile +++ b/Makefile @@ -5,9 +5,9 @@ define helpMessage possible values: test lint - build-for-windows-amd - build-for-linux-amd - build-for-darwin-arm + windows-amd + linux-amd + darwin-arm endef export helpMessage @@ -22,11 +22,11 @@ lint: 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 From a2fd7837b6ca56f5049ec8e3ffd23ce5740c1fca Mon Sep 17 00:00:00 2001 From: Arjun Aditya Date: Fri, 11 Oct 2024 21:01:08 +0530 Subject: [PATCH 3/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f16e573..846c2b6f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,38 @@ ## Contributing Guide -work in progress \ No newline at end of file +- 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 +``` + From 2ffba00813c876c4af94821e800898b06ddd06fc Mon Sep 17 00:00:00 2001 From: Arjun Aditya Date: Fri, 11 Oct 2024 21:19:13 +0530 Subject: [PATCH 4/6] Update Makefile --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index d550e033..046aa206 100644 --- a/Makefile +++ b/Makefile @@ -15,7 +15,7 @@ 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 From c7c5ae4e5987228d784d325649deaf8103cc9980 Mon Sep 17 00:00:00 2001 From: Arjun Aditya Date: Fri, 11 Oct 2024 21:23:58 +0530 Subject: [PATCH 5/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 846c2b6f..7bd898b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,10 @@ ## Contributing Guide +**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 ``` From 842fc6a9d7bacef31271c59e3ea6f131722026dd Mon Sep 17 00:00:00 2001 From: Arjun Aditya Date: Sat, 12 Oct 2024 23:52:58 +0530 Subject: [PATCH 6/6] chore: add darwin amd in makefile --- Makefile | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Makefile b/Makefile index 046aa206..7a40d1c2 100644 --- a/Makefile +++ b/Makefile @@ -8,6 +8,7 @@ possible values: windows-amd linux-amd darwin-arm + darwin-amd endef export helpMessage @@ -19,6 +20,7 @@ test: 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 @@ -30,3 +32,6 @@ linux-amd: 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