Course

GitHub Projects

Being a developer isn't just about writing code. It's also about showcasing your work, with others, and to the community in meaningful ways.

Let's check out some tips to help you create and manage projects on GitHub effectively.

Step 1: Pin Best Projects

The first thing you should do is to pin the repositories to your profile.

Image

This will help you showcase your best work to potential employers without them having to scroll through all your repositories.

Here are some tips to help you pin the best projects:

  • Your most important project, the one you are the most, must be pinned on the first slot.
  • over . Highlight a few top-notch projects.
  • Showcase a of projects to show your skills in different areas.
  • Keep the pinned projects with the latest features and improvements.
  • Ensure pinned projects are and have a clear README file.

Step 2: Project Documentation

Projects on GitHub are more than just lines of code—they represent your , , and .

Image

When you explore a major repository or an organization's GitHub page, you'll find README files, project descriptions, and tags. Any idea why?

It isn't just for show. It's because Documentation helps others what your project does and how to use it. It's for Project's success.

Specifically, in team projects, good documentation is especially important. It helps new team members get up to quickly. Not just that, it also helps in maintaining the project in the long run.

Employers value this skill highly as it shows you just writing code and can effectively your work to others.

Next, we'll teach you how to write a great README file for your awesome Project. For now, remember to:

  • Create a README file for each project

  • Use meaningful names for your projects

    Example

    ikea-clone, healthcare, etc instead of project1, project2, etc.

  • Write a clear and concise project description in About Section of Repository

    Image
  • In the same About Section, utilize topics feature to improve discoverability.

    Image
  • Add emojis for and .

  • Encourage others to appreciate your work by giving to your projects.

  • Remove releases, packages, or multiple environments if they are not relevant to your project.

Step 3: Mind Your Commits

Commit messages are not just annotations/notes/remarks to your code changes. They are a way to with your team members and future self.

Image

Why should I write good commit messages?

  • Clarity and Understanding

    Well-written commits provide clear explanations of changes were made and .

    This helps other developers (including your future self) understand the and behind each change without having to decipher the code itself.

  • Smooth Collaboration

    In team environments, clear commit messages make smoother collaboration.

    They help team members track progress, review changes efficiently, and resolve issues or conflicts that may arise during development.

  • Bug Tracking

    When issues arise, well-documented commits make it easier to to when and why a specific change was introduced.

    This helps in identifying the root cause of bugs and resolving them quickly. Otherwise, you know what happens when you can't find the bug, right?

Best Practices for Writing Commit Messages

  • Keep messages clear, concise, and meaningful for quick understanding of changes.
  • Avoid or messages like "update" or "fix" to provide valuable insights.
  • Ensure each message relates to specific changes, maintaining a project .
  • Maintain professionalism in language and avoid errors to reflect a high standard of work.
  • Make , commits rather than one large commit with multiple unrelated changes.
  • Use imperative mood (e.g., "fix", "add", "update") for consistency and clarity.
  • Take a moment to your changes and commit message before finalizing.

Examples

Example

Good Commit Messages

  • feat: Add user authentication feature
  • feat: Implement payment processing API integration
  • feat: Add user profile page
Example

Clear and Descriptive

  • fix: Resolve issue with form validation
  • fix: Update error handling for user login
  • fix: Correct spelling errors in README
Example

Logical Grouping of Changes

  • refactor: Reorganize file structure
  • refactor: Update variable names for clarity
  • refactor: Optimize code for performance
  • refactor: Remove redundant code
Example

Feature Development

  • feat: Implement payment processing API integration
  • feat: Add admin dashboard home page
  • feat: Integrate Sentry for application monitoring
  • feat: Implement SEO optimization for landing page
Example

Code Review Changes

  • style: Refactor variable names per code review feedback
  • refactor: Update function parameters for consistency
  • fix: Resolve linting errors in codebase after review
Example

Merge Conflict Resolution

  • merge: Resolve conflicts in feature-branch
  • merge: Update branch with latest changes from main
  • merge: Rebase feature-branch onto main

So, what are you waiting for? Start fixing your GitHub profile today!

0 Comments

"Please login to view comments"

glass-bbok

Join the Conversation!

Subscribing gives you access to the comments so you can share your ideas, ask questions, and connect with others.

Upgrade your account
tick-guideNext Lesson

Assignment: GitHub Projects