Skip to content

Commit 4968938

Browse files
teamssixteamssix
committed
init project
0 parents  commit 4968938

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+6099
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Bug 反馈
2+
description: 提交一个 issue 帮助改进这个项目
3+
title: "[Bug] 在这里输入你的标题"
4+
labels: ["bug"]
5+
assignees:
6+
- teamssix
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
感谢您花时间提交这份 issue
12+
- type: textarea
13+
id: what-happened
14+
attributes:
15+
label: 描述你遇到的问题
16+
value: "详细描述你所遇到的问题"
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: 复现步骤
22+
description: 复现这个问题的步骤
23+
placeholder: |
24+
1. 在 xxx 情况下
25+
2. 执行了 xxx 命令
26+
3. 出现了 xxx 错误
27+
validations:
28+
required: true
29+
- type: dropdown
30+
id: system
31+
attributes:
32+
label: 操作系统
33+
description: 你在哪个操作系统下运行的云鉴 ？
34+
options:
35+
- MacOS
36+
- Linux
37+
- Windows
38+
validations:
39+
required: true
40+
- type: dropdown
41+
id: system-type
42+
attributes:
43+
label: 系统类型
44+
description: 你在哪个系统类型下运行的云鉴 ？
45+
options:
46+
- amd64
47+
- amd32
48+
- arm64
49+
- arm32
50+
validations:
51+
required: true
52+
- type: dropdown
53+
id: cloudsword-version
54+
attributes:
55+
label: 云鉴版本
56+
description: 你运行的是云鉴的哪个版本？
57+
options:
58+
- 最新的 (Latest)
59+
- 0.0.1
60+
validations:
61+
required: true
62+
- type: textarea
63+
attributes:
64+
label: 补充信息
65+
description: |
66+
链接？参考资料？任何可以给我们提供更多关于你所遇到的问题的背景资料的东西
67+
68+
提示：你可以通过点击这个区域来突出显示它，然后将文件拖入，从而附上图片或其他文件。
69+
validations:
70+
required: false

‎.github/ISSUE_TEMPLATE/feat.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: 新功能反馈
2+
description: 提交一个功能需求帮助完善这个项目
3+
title: "[Feat] 在这里输入你的标题"
4+
labels: ["enhancement"]
5+
assignees:
6+
- teamssix
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
感谢您花时间提交这份 issue
12+
- type: textarea
13+
id: new-features
14+
attributes:
15+
label: 描述你希望增加的功能
16+
value: "详细描述你希望增加的功能，并且描述为什么想要增加这个功能以及意义，描述的越完善该反馈越有可能被采纳。"
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: 补充信息 (Anything else?)
22+
description: |
23+
链接？参考资料？任何可以给我们提供更多关于你所遇到的问题的背景资料的东西。
24+
25+
提示：你可以通过点击这个区域来突出显示它，然后将文件拖入，从而附上图片或其他文件。
26+
validations:
27+
required: false

‎.github/ISSUE_TEMPLATE/perf.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: 功能优化反馈
2+
description: 提交一个功能优化需求帮助改进这个项目
3+
title: "[Perf] 在这里输入你的标题"
4+
labels: ["performance"]
5+
assignees:
6+
- teamssix
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
感谢您花时间提交这份 issue
12+
- type: textarea
13+
id: performance
14+
attributes:
15+
label: 描述你希望优化的功能
16+
value: "详细描述你希望优化的功能，并且描述为什么想要对这个功能进行优化，描述的越完善该反馈越有可能被采纳。"
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: 补充信息
22+
description: |
23+
链接？参考资料？任何可以给我们提供更多关于你所遇到的问题的背景资料的东西
24+
25+
提示：你可以通过点击这个区域来突出显示它，然后将文件拖入，从而附上图片或其他文件。
26+
validations:
27+
required: false

‎.github/workflows/release.yaml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Release
2+
on:
3+
push:
4+
tags:
5+
- 'v*'
6+
env:
7+
GO_VERSION: 1.22.1
8+
9+
jobs:
10+
goreleaser:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout Source Code
14+
uses: actions/checkout@v3
15+
with:
16+
fetch-depth: 0
17+
- name: Setup Go Environment
18+
uses: actions/setup-go@v3
19+
with:
20+
go-version: ${{ env.GO_VERSION }}
21+
22+
- name: Run GoReleaser
23+
uses: goreleaser/goreleaser-action@v6
24+
with:
25+
version: 1.26.2
26+
args: release --clean
27+
env:
28+
CGO_ENABLED: 0
29+
GITHUB_TOKEN: ${{ secrets.RELEASE_GH_TOKEN }}

‎.gitignore

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# If you prefer the allow list template instead of the deny list, see community template:
2+
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
3+
#
4+
# Binaries for programs and plugins
5+
*.exe
6+
*.exe~
7+
*.dll
8+
*.so
9+
*.dylib
10+
11+
# Test binary, built with `go test -c`
12+
*.test
13+
14+
# Output of the go coverage tool, specifically when used with LiteIDE
15+
*.out
16+
17+
# Dependency directories (remove the comment below to include it)
18+
# vendor/
19+
tmp
20+
test
21+
misc
22+
build
23+
24+
# Go workspace file
25+
go.work
26+
.DS_Store
27+
.idea
28+
cloudsword
29+
cloudsword.bak

‎.goreleaser.yaml

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
project_name: cloudsword
2+
before:
3+
hooks:
4+
- go mod tidy
5+
- go generate ./...
6+
builds:
7+
- env:
8+
- CGO_ENABLED=0
9+
goos:
10+
- freebsd
11+
- darwin
12+
- windows
13+
- linux
14+
goarch:
15+
- 386
16+
- amd64
17+
- arm
18+
- arm64
19+
archives:
20+
- name_template: "{{ .ProjectName }}_{{ .Tag }}_{{ .Os }}_{{ .Arch }}"
21+
id: homebrew
22+
format: zip
23+
files:
24+
- README.md
25+
- CHANGELOG.md
26+
- LICENSE
27+
- static/*
28+
checksum:
29+
name_template: "checksums.txt"
30+
snapshot:
31+
name_template: "{{ incpatch .Version }}"
32+
changelog:
33+
sort: asc
34+
filters:
35+
exclude:
36+
- "^docs:"
37+
- "^doc:"
38+
- "^ci:"
39+
- "^Merge pull request"
40+
brews:
41+
- ids:
42+
- homebrew
43+
name: cloudsword
44+
tap:
45+
owner: wgpsec
46+
name: homebrew-tap
47+
branch: master
48+
folder: Formula
49+
url_template: "https://github.com/wgpsec/cloudsword/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
50+
homepage: "https://wiki.teamssix.com/cloudsword"
51+
description: "CloudSword is a public cloud security exploitation tool."
52+
skip_upload: auto
53+
install: |-
54+
bin.install "cloudsword"

‎CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## [v0.0.1](https://github.com/wgpsec/cloudsword/releases/tag/v0.0.1) 2024.12.21
2+
3+
* 首次提交代码

‎CONTRIBUTING.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## 为云鉴贡献代码
2+
3+
首先很高兴你看到这个，非常欢迎您和我一起完善云鉴，让我们一起编写一个好用的、有价值的、有意义的工具。
4+
5+
### 是否发现了 bug?
6+
7+
如果你发现了程序中的 bug，建议可以先在 [issue](https://github.com/wgpsec/cloudsword/issues) 中进行搜索，看看以前有没有人提交过相同的 bug。
8+
9+
### 发现了 bug，并准备自己为云鉴打补丁
10+
11+
如果你发现了 bug，而且准备自己去修补它的话，则可以先把云鉴 Fork 到自己的仓库中，然后修复完后，提交 PR 到云鉴的 dev 分支下，另外记得在 PR 中详细说明 bug 的产生条件以及你是如何修复的，这可以帮助你更快地使这个 PR 通过。
12+
13+
### 为云鉴增加新功能
14+
15+
如果你发现云鉴现在的功能不能满足自己的需求，并打算自己去增加上这个功能，则可以先把云鉴 Fork 到自己的仓库中，然后编写完相应的功能后，提交 PR 到云鉴 的 dev 分支下，另外记得在 PR 中详细说明增加的功能以及为什么要增加它，这可以帮助你更快地使这个 PR 通过。
16+
17+
建议师傅在增加新功能后，可以去完善对应的操作手册，操作手册项目地址：[github.com/teamssix/twiki](https://github.com/teamssix/twiki)，先 fork 操作手册项目，然后在 [github.
18+
com/teamssix/twiki/tree/main/docs/cloudsword](https://github.com/teamssix/twiki/tree/main/docs/cloudsword) 目录下编辑云鉴 操作手册的文档，最后提 pr 到 T Wiki 项目的 beta 分支下就行。
19+
20+
## 使你的 PR 更规范
21+
22+
### 规范 Git commit
23+
24+
commit message 应尽可能的规范，为了保证和其他 commit 统一，建议 commit message 采用英文描述，并符合下面的格式：
25+
26+
```yaml
27+
type: subject
28+
```
29+
30+
type 是 commit 的类别，subject 是对这个 commit 的英文描述，例如下面的示例：
31+
* feat: add object download function
32+
* perf: optimize the display of update progress bar
33+
关于 Git commit 的更多规范要求可以参见这篇文章：[如何规范你的Git commit？](https://zhuanlan.zhihu.com/p/182553920)
34+
35+
### 规范代码格式
36+
37+
代码在编写完后，应使用 `go fmt` 和 `goimports`对代码进行格式化，从而使代码看起来更加整洁。
38+
39+
在 goland 中可以设置当代码保存时自动格式化代码，配置的步骤可以参见这篇文章：[GoLand：设置gofmt与goimports，保存时自动格式化代码](https://blog.csdn.net/qq_32907195/article/details/116755338)

0 commit comments

Comments
 (0)