Skip to content
This repository was archived by the owner on Mar 24, 2026. It is now read-only.

Commit 0fc7c90

Browse files
committed
docs: finalize project archival and complete English translation
1 parent 97f284f commit 0fc7c90

7 files changed

Lines changed: 171 additions & 110 deletions

File tree

.cspell.json

Lines changed: 64 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,73 @@
11
{
22
"version": "0.2",
3-
"language": "en,pt",
3+
"language": "en",
44
"words": [
5-
"comando",
6-
"comandos",
7-
"eles",
8-
"stretchr"
5+
"afero",
6+
"ansi",
7+
"aymanbagabas",
8+
"cellbuf",
9+
"charmbracelet",
10+
"clis",
11+
"cobra",
12+
"codefactor",
13+
"colorprofile",
14+
"davecgh",
15+
"difflib",
16+
"enoque",
17+
"errorf",
18+
"esousa97",
19+
"eyer",
20+
"fan-out",
21+
"fixup",
22+
"fsnotify",
23+
"godoc",
24+
"gopath",
25+
"gopkg",
26+
"goreportcard",
27+
"goroutines",
28+
"gotenv",
29+
"httptest",
30+
"inconshreveable",
31+
"isatty",
32+
"lipgloss",
33+
"locafero",
34+
"lucasb",
35+
"mapstructure",
36+
"mattn",
37+
"mousetrap",
38+
"muesli",
39+
"pelletier",
40+
"pflag",
41+
"pmezard",
42+
"pretty-print",
43+
"rivo",
44+
"runewidth",
45+
"sagikazarmark",
46+
"sourcegraph",
47+
"spew",
48+
"spf13",
49+
"sousa",
50+
"stderr",
51+
"stdin",
52+
"stdout",
53+
"stretchr",
54+
"subosito",
55+
"termenv",
56+
"terminfo",
57+
"testify",
58+
"tk",
59+
"uniseg",
60+
"vercel",
61+
"viper",
62+
"waitgroups",
63+
"working-directory",
64+
"xo"
965
],
1066
"ignorePaths": [
1167
"node_modules",
1268
"vendor",
13-
".git"
69+
".git",
70+
"go.sum",
71+
"assets"
1472
]
1573
}

.golangci.yml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
linters-settings:
22
misspell:
3+
locale: US
34
ignore-words:
4-
- comando
5-
- comandos
6-
- eles
75
- stretchr
6+
- lipgloss
7+
- cobra
8+
- viper
9+
- goroutines
10+
- waitgroups
11+
- stdin
12+
- stdout
13+
- stderr
14+
- gopath
15+
- godoc
16+
- esousa97
17+
- enoque
18+
- sousa

CONTRIBUTING.md

Lines changed: 10 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Contributing to Go CLI Toolkit
22

3-
Thank you for considering a contribution. This document describes the development setup, conventions, and workflow required for submitting changes.
3+
> [!CAUTION]
4+
> **This project is ARCHIVED.**
5+
> It serves as a personal learning record for the Go language. As such, I am no longer actively reviewing Pull Requests or maintaining the codebase. You are encouraged to fork this repository for your own study and experimentation.
6+
7+
---
8+
9+
This document remains here for historical reference, documenting the standards and workflow used during the development of this project.
410

511
## Prerequisites
612

@@ -53,11 +59,7 @@ go vet ./...
5359
make build
5460
```
5561

56-
All checks must pass before opening a Pull Request.
57-
58-
## Branch Naming
59-
60-
Use the following prefixes:
62+
## Branch Naming (Historical)
6163

6264
| Prefix | Purpose | Example |
6365
|--------|---------|---------|
@@ -77,28 +79,6 @@ Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/):
7779
[optional body]
7880
```
7981

80-
Examples:
81-
82-
```
83-
feat: add CSV output format to ping command
84-
fix: handle empty stdin gracefully in format json
85-
docs: document config.yaml schema
86-
test: add edge cases for concurrent ping
87-
```
88-
89-
## Pull Request Process
90-
91-
1. Fork the repository and create your branch from `main`.
92-
2. Make your changes following the conventions above.
93-
3. Run `make test` and `go vet ./...` locally.
94-
4. Open a Pull Request with a clear title and description.
95-
5. Wait for review. Address feedback with fixup commits, then squash before merge.
96-
97-
## Areas Where Contributions Are Welcome
82+
## License
9883

99-
- New formatter subcommands (CSV, YAML, TOML)
100-
- Output export options (file, clipboard)
101-
- Additional ping protocols (TCP, ICMP)
102-
- Performance improvements in concurrent operations
103-
- Documentation improvements and translations
104-
- Test coverage expansion
84+
This project is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for details.

Makefile

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,29 @@
33
APP_NAME=tk
44
CMD_PATH=./cmd/toolkit
55

6-
# Comando padrão
6+
# Default target
77
all: build
88

9-
# Construção do ecossistema local na raiz do projeto
9+
# Build the local ecosystem at the project root
1010
build:
11-
@echo "Construindo o binário $(APP_NAME)..."
11+
@echo "Building binary $(APP_NAME)..."
1212
go build -o $(APP_NAME) $(CMD_PATH)
1313

14-
# Rodar testes unitários e lint básico
14+
# Run unit tests and basic linting
1515
test:
16-
@echo "Rodando a bateria de testes unitários..."
16+
@echo "Running unit test suite..."
1717
go test ./... -v -count=1
1818

19-
# Instalar app no diretório GOPATH global do ambiente do dev/usuário
19+
# Install app into global GOPATH/bin
2020
install:
21-
@echo "Instalando $(APP_NAME) no GOPATH/bin..."
21+
@echo "Installing $(APP_NAME) to GOPATH/bin..."
2222
go install $(CMD_PATH)
2323

24-
# Limpar binários
24+
# Clean build artifacts
2525
clean:
26-
@echo "Limpando artefatos criados..."
26+
@echo "Cleaning artifacts..."
2727
rm -f $(APP_NAME) $(APP_NAME).exe
2828

29-
# Executar a CLI em tempo de compilação rápida (bom pro fluxo de desenvolvimento)
29+
# Execute CLI in fast-compile mode (dev workflow)
3030
run:
3131
@go run $(CMD_PATH)/main.go

0 commit comments

Comments
 (0)