feat(ssh-guide): add SSH authentication guide for Git and servers#40
Merged
Conversation
closes #33 CHANGES - SSH Authentication Guide (new) - Full workflow: check keys, generate Ed25519, add to ssh-agent - Use Case: Git hosting with URL rewriting (HTTPS URLs, SSH auth) - Use Case: Remote servers with ssh-copy-id and SCP file transfer - Troubleshooting: permission denied, agent persistence - CONTRIBUTING.md - Add Prerequisites section requiring SSH and GPG setup - Bump version to v2.2.0 - SECURITY.md - Add Development Security section with CIA triad table - Bump version to v1.1.0 - README.md - Add SSH to workflows list - human-guides/README.md - Add SSH guide to Use Cases list IMPACT - Contributors now required to have SSH and GPG configured - Security guidance includes development workflow best practices
KemingHe
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an SSH authentication human guide and wires it into the repository’s contributor/security documentation so contributors can follow a consistent SSH + GPG workflow.
Changes:
- Added a new SSH authentication guide covering key generation, ssh-agent usage, Git URL rewriting, server auth, and troubleshooting.
- Updated contributor/security docs to reference SSH + GPG setup, and bumped guide/policy versions accordingly.
- Updated indexes (root README and
human-guides/README.md) to include the new SSH guide.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
human-guides/use-cases-ssh-authentication.md |
New end-to-end SSH authentication workflow guide (Git hosting + remote servers). |
human-guides/use-cases-gpg-commit-signing.md |
Updates GitHub “Add GPG key” steps and bumps guide version. |
human-guides/README.md |
Adds the SSH guide to the human-guides index. |
SECURITY.md |
Adds “Development Security” section referencing SSH/GPG guides and bumps policy version. |
README.md |
Includes SSH in the top-level workflows list. |
CONTRIBUTING.md |
Adds prerequisites requiring SSH + GPG setup and bumps contributing guide version. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CHANGES - SECURITY.md: add Availability row to CIA table (Git version control) - GPG guide: add missing "paste public key" step in Add to GitHub - SSH guide: update title example for consistency
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
closes #33
CHANGES
IMPACT