Skip to content

cailinyi166-ctrl/github-best-practices

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 

Repository files navigation

github-best-practices

This marks the first step of my GitHub journey. This handbook is a collaborative logic framework co-created by me and Gemini. Thanks for stopping by!

GitHub Productivity & Best Practices Handbook πŸš€

This handbook is designed for digital producers and decision-makers to master GitHub efficiently, focusing on output-driven value rather than "fake busyness."

1. Getting Started: The Foundation πŸ—οΈ

  • Repository First: Every project resides in a Repository. You must create one before uploading your project files or notes.
  • English-First Documentation: Professionalism starts with the README. Always write your README in English from the start to explain the project's logic and features clearly
  • Understanding the "Green Squares":
    • Contributions are recorded when you push to default branches (main/master), open issues, submit Pull Requests (PRs), or perform code reviews
    • Caution: The contribution calendar reflects your consistency. However, avoid "fake busyness"β€”don't create empty repositories just to turn squares green without actual learning notes or code.

2. Discovery: High-Signal Filtering πŸ“‘

  • Explore Tab: Use the "Explore" feature (via the top-left menu) to find projects tailored to your tech stack and environment
  • HelloGitHub Strategy: To avoid information overload, use HelloGitHub as a filter. Review their monthly/weekly reports for curated high-quality projects, then visit the official GitHub repo for deep dives

3. The Decision Tree: Is it worth your time? 🌳

Before deep-diving into a recommended English project, ask yourself these three questions

Question Purpose
New Framework? Does it offer a logic/methodology that is significantly faster (e.g., 10x) than your current one?
Productivity Boost? Can it directly automate your tasks (e.g., auto-generating weekly reports)?
Code Portability? Can you "migrate" or reuse specific functions in your own projects?

Action: If you answer YES to at least one, it is worth exploring the source code

4. Advanced Search Hacks πŸ”

Precision searching saves your most valuable resource: time

  • Scoped Search: Use in:name or in:description followed by keywords (e.g., in:name automation) to find repositories with specific terms in their title or summary
  • The "Awesome" Prefix: Prefix your search with awesome to find curated lists of high-quality resources and projects managed by experts

5. Philosophy of Reading READMEs πŸ’‘

  • AI Collaboration: If a README is too complex, use AI to summarize the logic and usage
  • Focus on the "Why": Don't just look at how to use it. Always ask: "Why did the creator start this? What specific problem or framework were they trying to build?"

About

This marks the first step of my GitHub journey. This handbook is a collaborative logic framework co-created by me and Gemini. Thanks for stopping by!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors