Repository navigation
chore: open source readiness #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
297e7eb
chore: ignore dotenv files, keep .env.example committable
everton-dgn 699bb33
chore: add repository metadata and pin pnpm via packageManager
everton-dgn 20753c1
ci: add GitHub Actions workflow
everton-dgn 7e4f068
docs: add contributing guide, code of conduct and GitHub templates
everton-dgn 1e856c9
chore: exclude community files from vsix package
everton-dgn 566ea2f
chore: rename vitest.config.ts to .mts for ESM-native loading
everton-dgn 34dc9d5
chore: exclude remaining docs from vsix package
everton-dgn e170721
ci: restrict pull_request trigger to main, disable checkout credentia…
everton-dgn bf7cc7d
chore: exclude dotenv files from vsix package
everton-dgn e99f163
docs: translate all documentation to english
everton-dgn ab4d974
docs: translate code comments to english
everton-dgn 4e68cae
chore: translate remaining script output string to english
everton-dgn 7352674
docs: address review findings on disclosure statement and fallback co…
everton-dgn File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| name: Bug report | ||
| about: Something does not work as expected | ||
| title: "fix: " | ||
| labels: bug | ||
| --- | ||
|
|
||
| **Describe the bug** | ||
|
|
||
| <!-- What happened and what you expected to happen. --> | ||
|
|
||
| **How to reproduce** | ||
|
|
||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| **Environment** | ||
|
|
||
| - Editor (VS Code or VSCodium) and version: | ||
| - Operating system: | ||
| - Provider used (claudeCli, codexCli, openrouter, ...): | ||
| - Extension version: | ||
|
|
||
| **Logs** | ||
|
|
||
| <!-- Output > Generate Commit. The log only contains metadata; even so, | ||
| check it before pasting. NEVER include API keys, diffs or provider | ||
| responses. --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| name: Feature request | ||
| about: An idea to improve the extension | ||
| title: "feat: " | ||
| labels: enhancement | ||
| --- | ||
|
|
||
| **What problem it solves** | ||
|
|
||
| <!-- Describe the pain point or use case. --> | ||
|
|
||
| **Proposed solution** | ||
|
|
||
| <!-- How you imagine it should work. --> | ||
|
|
||
| **Alternatives considered** | ||
|
|
||
| <!-- Other ways of solving it that you evaluated. --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ## Summary | ||
|
|
||
| <!-- What changes and why. --> | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] `pnpm typecheck`, `pnpm lint`, `pnpm test` and `pnpm build` pass locally | ||
| - [ ] Commits follow Conventional Commits (in English, atomic) | ||
| - [ ] New behavior has a test in `tests/` | ||
| - [ ] `README.md` and `CHANGELOG.md` updated, if the change is user-visible | ||
| - [ ] No key, secret or sensitive diff included |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| with: | ||
| persist-credentials: false | ||
|
|
||
| - uses: pnpm/action-setup@v4 | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: lts/* | ||
| cache: pnpm | ||
|
|
||
| - run: pnpm install --frozen-lockfile | ||
| - run: pnpm typecheck | ||
| - run: pnpm lint | ||
| - run: pnpm test | ||
| - run: pnpm build | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,3 +3,5 @@ dist/ | |
| *.vsix | ||
| .vscode-test/ | ||
| coverage/ | ||
| .env* | ||
| !.env.example | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,71 @@ | ||
| # Changelog | ||
|
|
||
| Todas as mudanças notáveis deste projeto são documentadas aqui, seguindo o | ||
| espírito do [Keep a Changelog](https://keepachangelog.com/pt-BR/1.1.0/) e | ||
| versionamento semântico. | ||
| All notable changes to this project are documented here, following the | ||
| spirit of [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and | ||
| semantic versioning. | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ### Adicionado | ||
| ### Added | ||
|
|
||
| - `generateCommit.disableThinking`: desliga o raciocínio nos providers CLI | ||
| para menor latência (Codex com `model_reasoning_effort="none"`, Claude | ||
| CLI com `MAX_THINKING_TOKENS=0`). O dropdown de Effort fica desabilitado | ||
| no painel enquanto o toggle está ligado. | ||
| - Campo "Custom prompt instructions" agora é uma textarea multilinha | ||
| redimensionável verticalmente. | ||
| - Sugestões de modelo ao vivo no campo Model do painel: a lista completa é | ||
| buscada no endpoint de modelos de cada provider (cache de 1 hora) e | ||
| modelos novos aparecem automaticamente no dropdown, com a opção "Custom…" | ||
| para digitar um ID fora da lista. | ||
| - Codex CLI: catálogo vivo de modelos via `codex debug models` e dropdown | ||
| de Effort com os níveis de reasoning do modelo selecionado (cache de 1 | ||
| hora; fallback estático quando o CLI não responde). | ||
| - Claude CLI: dropdown de Model com os aliases `fable`, `opus`, `sonnet` e | ||
| `haiku`, e dropdown de Effort com os 5 níveis do `--effort`. | ||
| - `generateCommit.disableThinking`: disables reasoning on CLI providers for | ||
| lower latency (Codex with `model_reasoning_effort="none"`, Claude CLI | ||
| with `MAX_THINKING_TOKENS=0`). The Effort dropdown is disabled in the | ||
| panel while the toggle is on. | ||
| - The "Custom prompt instructions" field is now a vertically resizable | ||
| multiline textarea. | ||
| - Live model suggestions in the panel's Model field: the full list is | ||
| fetched from each provider's models endpoint (1-hour cache) and new | ||
| models appear automatically in the dropdown, with a "Custom…" option to | ||
| type an ID outside the list. | ||
| - Codex CLI: live model catalog via `codex debug models` and an Effort | ||
| dropdown with the reasoning levels of the selected model (1-hour cache; | ||
| static fallback when the CLI does not respond). | ||
| - Claude CLI: Model dropdown with the `fable`, `opus`, `sonnet` and | ||
| `haiku` aliases, and an Effort dropdown with the 5 `--effort` levels. | ||
|
|
||
| ### Alterado | ||
| ### Changed | ||
|
|
||
| - Painel de configurações: os campos do provider ativo (Model, Effort, | ||
| Base URL, Auth header) ficam na seção Provider; a seção "Advanced per | ||
| provider" foi removida. | ||
| - Campo de idioma virou dropdown com lista de idiomas + opção "Custom…" | ||
| (antes: texto livre com datalist). | ||
| - Selects do painel com seta SVG própria, border-radius de 5px e padding | ||
| ajustado. | ||
| - Settings panel: the active provider's fields (Model, Effort, Base URL, | ||
| Auth header) live in the Provider section; the "Advanced per provider" | ||
| section was removed. | ||
| - The language field became a dropdown with a language list plus a | ||
| "Custom…" option (previously: free text with a datalist). | ||
| - Panel selects with their own SVG arrow, 5px border-radius and adjusted | ||
| padding. | ||
|
|
||
| ## [0.1.0] - 2026-08-02 | ||
|
|
||
| Primeira versão funcional. | ||
| First functional version. | ||
|
|
||
| ### Adicionado | ||
| ### Added | ||
|
|
||
| - Geração de mensagem de commit (Conventional Commits) a partir do diff | ||
| staged, escrita na caixa de commit do Source Control para revisão, sem | ||
| nunca commitar automaticamente. | ||
| - Botão com ícone de estrelinhas na caixa de commit (menu `scm/inputBox`, | ||
| API proposta `contribSourceControlInputBoxMenu`, habilitável via | ||
| `--enable-proposed-api=everton.generate-commit`), com fallback pela | ||
| Command Palette. | ||
| - Providers plugáveis: OpenRouter, Anthropic-compatible (presets Kimi, | ||
| GLM, MiniMax e endpoint custom com auth `x-api-key` ou `bearer`), Claude | ||
| Code CLI e Codex CLI (ambos sem chave, usando o login do próprio CLI). | ||
| - Painel Generate Commit na Activity Bar: formulário inline na sidebar com | ||
| todas as configurações (provider, modelo, chaves de API com status, | ||
| idioma, limites, comportamento, timeout e seções avançadas por provider), | ||
| validado e sem janelas flutuantes. | ||
| - Segurança: varredura local de segredos com bloqueio por padrão (opt-in | ||
| por ocorrência), exclusão de lockfiles/binários/minificados/arquivos | ||
| grandes, truncamento sinalizado no prompt, chaves somente em | ||
| SecretStorage, somente HTTPS, zero telemetria, log apenas de metadados | ||
| com redação de segredos, cancelamento que mata o grupo de processos do | ||
| CLI e guarda contra gerações concorrentes e diff obsoleto. | ||
| - Multi-repo com QuickPick de escolha quando ambíguo; suporte a diff | ||
| unstaged configurável (`ask`/`always`/`never`). | ||
| - Erros de provider distintos e acionáveis (autenticação, créditos, rate | ||
| limit, servidor, rede, timeout). | ||
| - Documentação: README, `docs/ARCHITECTURE.md`, `SECURITY.md`, tabela de | ||
| verificações datadas (endpoints, model IDs e flags verificados em fontes | ||
| oficiais em 2026-08-02). | ||
| - Commit message generation (Conventional Commits) from the staged diff, | ||
| written into the Source Control commit box for review, never committing | ||
| automatically. | ||
| - Button with a sparkles icon in the commit box (`scm/inputBox` menu, | ||
| proposed API `contribSourceControlInputBoxMenu`, enabled via | ||
| `--enable-proposed-api=everton.generate-commit`), with a Command Palette | ||
| fallback. | ||
| - Pluggable providers: OpenRouter, Anthropic-compatible (Kimi, GLM, MiniMax | ||
| presets and a custom endpoint with `x-api-key` or `bearer` auth), Claude | ||
| Code CLI and Codex CLI (both keyless, using the CLI's own login). | ||
| - Generate Commit panel on the Activity Bar: inline form in the sidebar | ||
| with every setting (provider, model, API keys with status, language, | ||
| limits, behavior, timeout and advanced per-provider sections), validated | ||
| and with no floating windows. | ||
| - Security: local secret scanning with blocking by default (per-occurrence | ||
| opt-in), exclusion of lockfiles/binaries/minified/large files, truncation | ||
| flagged in the prompt, keys only in SecretStorage, HTTPS only, zero | ||
| telemetry, metadata-only logging with secret redaction, cancellation that | ||
| kills the CLI process group, and guards against concurrent generations | ||
| and stale diffs. | ||
| - Multi-repo with a selection QuickPick when ambiguous; configurable | ||
| unstaged diff support (`ask`/`always`/`never`). | ||
| - Distinct, actionable provider errors (authentication, credits, rate | ||
| limit, server, network, timeout). | ||
| - Documentation: README, `docs/ARCHITECTURE.md`, `SECURITY.md`, dated | ||
| verification table (endpoints, model IDs and flags verified against | ||
| official sources on 2026-08-02). | ||
|
|
||
| [0.1.0]: https://github.com/everton-dgn/generate-commit-extension/releases/tag/v0.1.0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. | ||
|
|
||
| We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to a positive environment for our community include: | ||
|
|
||
| * Demonstrating empathy and kindness toward other people | ||
| * Being respectful of differing opinions, viewpoints, and experiences | ||
| * Giving and gracefully accepting constructive feedback | ||
| * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience | ||
| * Focusing on what is best not just for us as individuals, but for the overall community | ||
|
|
||
| Examples of unacceptable behavior include: | ||
|
|
||
| * The use of sexualized language or imagery, and sexual attention or advances of any kind | ||
| * Trolling, insulting or derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or email address, without their explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
|
||
| ## Enforcement Responsibilities | ||
|
|
||
| Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. | ||
|
|
||
| Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement via [GitHub Security Advisories](https://github.com/everton-dgn/generate-commit-extension/security/advisories/new), this repository's private channel for any sensitive report, whether related to conduct or to security. All complaints will be reviewed and investigated promptly and fairly. | ||
|
|
||
| All community leaders are obligated to respect the privacy and security of the reporter of any incident. | ||
|
|
||
| ## Enforcement Guidelines | ||
|
|
||
| Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: | ||
|
|
||
| ### 1. Correction | ||
|
|
||
| **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. | ||
|
|
||
| **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. | ||
|
|
||
| ### 2. Warning | ||
|
|
||
| **Community Impact**: A violation through a single incident or series of actions. | ||
|
|
||
| **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. | ||
|
|
||
| ### 3. Temporary Ban | ||
|
|
||
| **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. | ||
|
|
||
| **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. | ||
|
|
||
| ### 4. Permanent Ban | ||
|
|
||
| **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. | ||
|
|
||
| **Consequence**: A permanent ban from any sort of public interaction within the community. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. | ||
|
|
||
| Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
|
||
| For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
| [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html | ||
| [Mozilla CoC]: https://github.com/mozilla/diversity | ||
| [FAQ]: https://www.contributor-covenant.org/faq | ||
| [translations]: https://www.contributor-covenant.org/translations |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.