Adiciona seção sobre GitHub e melhora consistência geral#28
Adiciona seção sobre GitHub e melhora consistência geral#28jadsonmorais wants to merge 1 commit into
Conversation
Inclui novos capítulos sobre clone, .gitignore, remote, push e pull, além de uma seção completa de colaboração no GitHub (fork, pull request, code review e resolução de conflitos). Também padroniza main/master, atualiza checkout -b para switch -c e corrige a descrição de tags annotated/lightweight.
📝 WalkthroughWalkthroughThis PR expands a Portuguese Git tutorial by adding five new command reference pages ( ChangesGit Tutorial Documentation Expansion
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
README.md (1)
39-39: 💤 Low valueInconsistent link format for stash.md.
Line 39 uses
3-comandos/stash.md(no leading slash) while all other command links use/3-comandos/filename.md(with leading slash). Normalize this to match the convention.♻️ Proposed fix
-18. [Stash](3-comandos/stash.md) +18. [Stash](/3-comandos/stash.md)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 39, The link to stash.md on line 39 uses the format `3-comandos/stash.md` without a leading slash, which is inconsistent with the convention used for all other command links that include a leading slash (e.g., `/3-comandos/filename.md`). Add a leading slash to the stash.md link reference to change `[Stash](3-comandos/stash.md)` to `[Stash](/3-comandos/stash.md)` to match the established link format convention throughout the document.5-github/o-que-e-github.md (1)
16-22: ⚡ Quick winSpecify a language for the ASCII diagram code block.
The fenced code block on line 16 is missing a language identifier. Since it's a text diagram, add
textorplaintextafter the opening triple backticks.Fix code block language specifier
-``` +```text Sua máquina GitHub🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@5-github/o-que-e-github.md` around lines 16 - 22, The ASCII diagram code block is missing a language identifier after the opening triple backticks. Add `text` as the language specifier after the opening triple backticks (```) for the code block containing the diagram that shows the relationship between "Sua máquina" and "repositório remoto" to properly format it as a text-based diagram in the markdown file.5-github/resolvendo-conflitos.md (1)
14-19: ⚡ Quick winSpecify a language for the merge conflict output code block.
The fenced code block on line 14 shows terminal merge output but lacks a language identifier. Add
bashorshellto indicate it's a command-line example.Fix code block language specifier
-``` +```bash $ git merge feature/cadastro-de-clientes🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@5-github/resolvendo-conflitos.md` around lines 14 - 19, The fenced code block displaying the git merge output (starting with $ git merge feature/cadastro-de-clientes) is missing a language identifier. Add bash as the language specifier by changing the opening fence from triple backticks to triple backticks followed by bash (```bash) to properly indicate this is a command-line terminal example and enable correct syntax highlighting in the rendered markdown.3-comandos/push.md (1)
26-29: ⚡ Quick winAdd language specification to the error output code block.
Line 26 starts a code fence without a language specification. This Git error message should be marked as
textfor consistency with markdown standards.♻️ Proposed fix
-``` +```text ! [rejected] main -> main (fetch first)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@3-comandos/push.md` around lines 26 - 29, The code fence starting at line 26 in the push.md file is missing a language specification. Add the `text` language identifier immediately after the opening triple backticks (```) on line 26 to properly mark the Git error message output block according to markdown standards.3-comandos/gitignore.md (1)
10-12: ⚡ Quick winAdd language specification to the code block.
Line 10 starts a code fence without specifying the language. Since the command
touch .gitignoreis a shell command, addbashlanguage specification for clarity and linter compliance.♻️ Proposed fix
-``` +```bash $ touch .gitignore🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@3-comandos/gitignore.md` around lines 10 - 12, The code fence for the shell command is missing a language specification. Add `bash` immediately after the opening three backticks (`) on the line that starts the code block containing the `touch .gitignore` command. Change the opening fence from triple backticks with no language to triple backticks followed by `bash` to properly identify this as a shell command block for syntax highlighting and linter compliance.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@3-comandos/repositorio.md`:
- Line 16: The section numbering in navigation links across multiple files is
off by one due to treating Repositório as section 3.1 when it should be section
3. Fix all five affected navigation links by incrementing each section number by
one: In 3-comandos/repositorio.md at lines 16, change "3.1.1. Clone" to "3.2.
Clone" and "3.2. Config" to "3.3. Config". In 3-comandos/config.md at line 20,
change "3.3. .gitignore" to "3.4. .gitignore". In 3-comandos/reset.md at line
23, change "3.12. Remote" to "3.13. Remote". In 3-comandos/log.md at line 51,
change "3.17. Stash" to "3.18. Stash". In 3-comandos/stash.md at line 142,
change "3.18. Cherry-pick" to "3.19. Cherry-pick".
---
Nitpick comments:
In `@3-comandos/gitignore.md`:
- Around line 10-12: The code fence for the shell command is missing a language
specification. Add `bash` immediately after the opening three backticks (`) on
the line that starts the code block containing the `touch .gitignore` command.
Change the opening fence from triple backticks with no language to triple
backticks followed by `bash` to properly identify this as a shell command block
for syntax highlighting and linter compliance.
In `@3-comandos/push.md`:
- Around line 26-29: The code fence starting at line 26 in the push.md file is
missing a language specification. Add the `text` language identifier immediately
after the opening triple backticks (```) on line 26 to properly mark the Git
error message output block according to markdown standards.
In `@5-github/o-que-e-github.md`:
- Around line 16-22: The ASCII diagram code block is missing a language
identifier after the opening triple backticks. Add `text` as the language
specifier after the opening triple backticks (```) for the code block containing
the diagram that shows the relationship between "Sua máquina" and "repositório
remoto" to properly format it as a text-based diagram in the markdown file.
In `@5-github/resolvendo-conflitos.md`:
- Around line 14-19: The fenced code block displaying the git merge output
(starting with $ git merge feature/cadastro-de-clientes) is missing a language
identifier. Add bash as the language specifier by changing the opening fence
from triple backticks to triple backticks followed by bash (```bash) to properly
indicate this is a command-line terminal example and enable correct syntax
highlighting in the rendered markdown.
In `@README.md`:
- Line 39: The link to stash.md on line 39 uses the format `3-comandos/stash.md`
without a leading slash, which is inconsistent with the convention used for all
other command links that include a leading slash (e.g.,
`/3-comandos/filename.md`). Add a leading slash to the stash.md link reference
to change `[Stash](3-comandos/stash.md)` to `[Stash](/3-comandos/stash.md)` to
match the established link format convention throughout the document.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8772d027-19d4-4209-9fc9-562aadd830a3
📒 Files selected for processing (21)
3-comandos/branch.md3-comandos/cherry-pick.md3-comandos/clone.md3-comandos/config.md3-comandos/gitignore.md3-comandos/log.md3-comandos/merge.md3-comandos/pull.md3-comandos/push.md3-comandos/remote.md3-comandos/repositorio.md3-comandos/reset.md3-comandos/stash.md3-comandos/status.md3-comandos/tag.md4-gitflow/padrao-commit.md5-github/code-review.md5-github/fork-e-pull-request.md5-github/o-que-e-github.md5-github/resolvendo-conflitos.mdREADME.md
| Simples, não é mesmo?! | ||
|
|
||
| Ir para: [3.2. Config](config.md) No newline at end of file | ||
| Ir para: [3.1.1. Clone](clone.md), uma forma alternativa de iniciar um repositório a partir de um projeto já existente, ou direto para [3.2. Config](config.md) No newline at end of file |
There was a problem hiding this comment.
Systematic off-by-one error in section numbering across command navigation links.
All five navigation link updates reference section numbers that are one less than their position in the README roadmap. The root cause is treating the README's 1-based item counting (items 1–19) as if Repositório itself is "3.1", when it should be: Repositório=3.1, Clone=3.2, etc.
3-comandos/repositorio.md#L16-L16: Change "3.1.1. Clone" → "3.2. Clone" and "3.2. Config" → "3.3. Config"3-comandos/config.md#L20-L20: Change "3.3. .gitignore" → "3.4. .gitignore"3-comandos/reset.md#L23-L23: Change "3.12. Remote" → "3.13. Remote"3-comandos/log.md#L51-L51: Change "3.17. Stash" → "3.18. Stash"3-comandos/stash.md#L142-L142: Change "3.18. Cherry-pick" → "3.19. Cherry-pick"
📍 Affects 5 files
3-comandos/repositorio.md#L16-L16(this comment)3-comandos/config.md#L20-L203-comandos/reset.md#L23-L233-comandos/log.md#L51-L513-comandos/stash.md#L142-L142
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@3-comandos/repositorio.md` at line 16, The section numbering in navigation
links across multiple files is off by one due to treating Repositório as section
3.1 when it should be section 3. Fix all five affected navigation links by
incrementing each section number by one: In 3-comandos/repositorio.md at lines
16, change "3.1.1. Clone" to "3.2. Clone" and "3.2. Config" to "3.3. Config". In
3-comandos/config.md at line 20, change "3.3. .gitignore" to "3.4. .gitignore".
In 3-comandos/reset.md at line 23, change "3.12. Remote" to "3.13. Remote". In
3-comandos/log.md at line 51, change "3.17. Stash" to "3.18. Stash". In
3-comandos/stash.md at line 142, change "3.18. Cherry-pick" to "3.19.
Cherry-pick".
Inclui novos capítulos sobre clone, .gitignore, remote, push e pull, além de uma seção completa de colaboração no GitHub (fork, pull request, code review e resolução de conflitos). Também padroniza main/master, atualiza checkout -b para switch -c e corrige a descrição de tags annotated/lightweight.
Summary by CodeRabbit