github-presence – skill Lập trình cho agent AI

GitHub Presence

When to Use

Use this skill when you need when the user wants to optimize their GitHub profile, README, or project discoverability. Trigger phrases include "GitHub README," "README optimization," "GitHub profile," "GitHub stars," "GitHub discoverability," "awesome lists," or "GitHub marketing.".

GitHub is where developers evaluate your project before trying it. This skill covers README optimization, profile READMEs, discoverability through topics and awesome lists, and using GitHub features for marketing.

---

Before You Start

1. Read .agents/developer-audience-context.md if it exists

2. Audit your current GitHub presence (profile, pinned repos, READMEs)

3. Understand: GitHub is often the first technical evaluation — optimize accordingly

---

README Structure

The Anatomy of a Great README

| Section | Purpose | Required? |

|---------|---------|-----------|

| Logo/Banner | Brand recognition, visual appeal | Recommended |

| Badges | Quick trust signals, status | Recommended |

| One-liner | What it does in one sentence | Required |

| Hero example | Immediate "what does it look like?" | Highly recommended |

| Features | Why use this over alternatives | Required |

| Quick start | Get running in < 2 minutes | Required |

| Installation | All installation methods | Required |

| Usage | Core usage examples | Required |

| Documentation | Link to full docs | Required |

| Contributing | How to contribute | Recommended |

| License | Legal clarity | Required |

README Template

<div align="center">
  <img src="logo.svg" alt="Project Name" width="200">
  <h1>Project Name</h1>
  <p><strong>One compelling sentence explaining what this does.</strong></p>

  <!-- Badges -->
  <a href="https://github.com/org/repo/actions"><img src="https://github.com/org/repo/workflows/CI/badge.svg" alt="CI"></a>
  <a href="https://www.npmjs.com/package/name"><img src="https://img.shields.io/npm/v/name.svg" alt="npm version"></a>
  <a href="https://github.com/org/repo/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
  <a href="https://discord.gg/invite"><img src="https://img.shields.io/discord/123456789" alt="Discord"></a>

  <br>
  <br>

  <a href="https://docs.example.com">Documentation</a> •
  <a href="https://example.com">Website</a> •
  <a href="https://discord.gg/invite">Discord</a>
</div>

---

## Why Project Name?

- **Feature 1** — Brief explanation
- **Feature 2** — Brief explanation
- **Feature 3** — Brief explanation

## Quick Start

npm install project-name

import { thing } from 'project-name';

const result = thing.doSomething();

console.log(result);

## Installation

### npm

npm install project-name

### yarn

yarn add project-name

### pnpm

pnpm add project-name

## Usage

### Basic Example

// Code example with comments

### Advanced Example

// More complex example

## Documentation

Full documentation available at [docs.example.com](https://docs.example.com)

- [Getting Started](https://docs.example.com/getting-started)
- [API Reference](https://docs.example.com/api)
- [Examples](https://docs.example.com/examples)

## Contributing

We welcome contributions! Link the project’s actual contribution guide here after confirming its path; this skill does not bundle one.

## License

MIT © [Your Name](https://yoursite.com)

---

Badges That Matter

Trust Signal Badges

| Badge | What it shows | When to use |

|-------|--------------|-------------|

| CI/Build status | Result of the linked workflow, not overall quality | When meaningful |

| Version | Latest release | Always for packages |

| License | Legal clarity | Always |

| Downloads/installs | Adoption | When impressive |

| Coverage | Executed lines/branches for the measured suite; not test quality | When current and accurately scoped |

| Security | Audit status | If you have it |

Community Badges

| Badge | Source | Purpose |

|-------|--------|---------|

| Discord members | shields.io | Show active community |

| GitHub stars | shields.io | Social proof |

| Contributors | shields.io | Open source health |

| Last commit | shields.io | Project activity |

Badge Services

| Service | URL | Best for |

|---------|-----|----------|

| Shields.io | shields.io | Most badges |

| Badgen | badgen.net | Fast, minimal |

| GitHub badges | Native | Actions, issues |

Badge Examples

<!-- Build status -->
![CI](https://github.com/org/repo/workflows/CI/badge.svg)

<!-- npm version -->
[![npm](https://img.shields.io/npm/v/package-name.svg)](https://www.npmjs.com/package/package-name)

<!-- Downloads -->
[![Downloads](https://img.shields.io/npm/dm/package-name.svg)](https://www.npmjs.com/package/package-name)

<!-- License -->
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

<!-- Discord -->
[![Discord](https://img.shields.io/discord/SERVER_ID?color=7289da&logo=discord&logoColor=white)](https://discord.gg/invite)

<!-- Stars -->
[![GitHub stars](https://img.shields.io/github/stars/org/repo?style=social)](https://github.com/org/repo)

---

Profile README

Setting Up Profile README

1. Create a repository with your username (e.g., github.com/yourname/yourname)

2. Make that repository public and add nonempty README.md at its root.

3. GitHub displays it on eligible personal profiles; managed user accounts do not support profile READMEs.

Profile README Structure

# Hi, I'm [Name] 👋

[One sentence about what you do]

## What I'm Working On

- 🔭 Building [project] — [brief description]
- 🌱 Learning [technology]
- 💬 Ask me about [expertise areas]

## Projects

| Project | Description | Stars |
|---------|-------------|-------|
| [Project 1](https://github.com/jonathimer/devmarketing-skills/tree/main/skills/github-presence/link) | Brief description | ![Stars](https://github.com/jonathimer/devmarketing-skills/tree/main/skills/github-presence/badge) |
| [Project 2](https://github.com/jonathimer/devmarketing-skills/tree/main/skills/github-presence/link) | Brief description | ![Stars](https://github.com/jonathimer/devmarketing-skills/tree/main/skills/github-presence/badge) |

## Recent Blog Posts

<!-- BLOG-POST-LIST:START -->
<!-- Automated with GitHub Actions -->
<!-- BLOG-POST-LIST:END -->

## Connect

[![Twitter](https://img.shields.io/badge/-Twitter-1DA1F2?style=flat&logo=twitter&logoColor=white)](https://twitter.com/handle)
[![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white)](https://linkedin.com/in/handle)

## GitHub Stats

![Your GitHub stats](https://github-readme-stats.vercel.app/api?username=yourusername&show_icons=true)

Profile README Best Practices

| Do | Don't |

|----|-------|

| Keep it scannable | Write paragraphs |

| Show your best projects | List everything |

| Include current work | Let it get stale |

| Add contact methods | Make it hard to reach you |

| Show personality | Be generic |

---

Discoverability

GitHub Topics

Topics are how people find repositories. Optimize for search.

| Topic strategy | Example |

|----------------|---------|

| Technology | javascript, rust, python |

| Framework | react, nextjs, django |

| Use case | cli, api, testing |

| Category | developer-tools, devops |

| Problem | authentication, caching |

Add topics: Repository settings → Topics (up to 20)

Search Optimization

GitHub search considers:

1. Repository name — Include main keyword

2. Description — 350 chars, keyword-rich

3. README content — Full text indexed

4. Topics — Category matching

5. Language — Auto-detected

Awesome Lists

Getting on awesome lists drives traffic and credibility.

| Step | Action |

|------|--------|

| 1 | Find relevant awesome lists (search "awesome + [topic]") |

| 2 | Check list requirements (quality, activity, docs) |

| 3 | Ensure your project meets criteria |

| 4 | Submit PR following list's guidelines |

| 5 | Be patient — curation takes time |

Popular awesome lists for dev tools:

• awesome-cli-apps
• awesome-selfhosted
• awesome-nodejs
• awesome-python
• awesome-go
• awesome-rust
• awesome-devops

---

GitHub Actions for Marketing

Automation examples need adaptation, not direct installation: review each third-party action and pin its full verified commit SHA (floating master/latest tags below are placeholders). Grant minimum token permissions and avoid passing secrets to untrusted actions. Use a topic-branch PR for README changes where branch protection requires it; never bypass protections or publish posts, sponsorship terms or external PRs without authorization. A stats embed is an external service, not proof of usage. Use actual project license/links rather than copying MIT or upstream template URLs.

Repository

… (nội dung đầy đủ có trong gói tải về)