pwshub.com

How to Manage your Open Source Project with GitHub

How to Manage your Open Source Project with GitHub

Managing your repository is one of the most important tasks for every open-source, individual, or proprietary software project.

Small open-source project repositories are easily maintained without using additional functionality because few developers work on them.

However, when working with medium or large open-source projects, the main problem lies in how to manage them.

With many developers contributing at the same time and the developer community rapidly expanding day by day, this becomes a significant challenge.

GitHub, GitLab, Gitea, and so on, have similar functionalities that help you and your team to manage your project more efficiently. Without relying on other software and tools, you can handle your project with your repository.

In this tutorial, we'll discuss three basic GitHub features that can help you to manage your repository more efficiently without using any additional tools or services:

  1. Labels

  2. Projects

  3. Milestones

GitHub, Gitlab, or Gitea all have similar functionalities with the same name.

How to Use Labels on GitHub

Label example in GitHub

The label helps categorize issues, pull requests, and discussions. By default, GitHub comes with some built-in labels.

Default Github label list

You can also create a custom label. You can use the label on any issue, pull request, or discussion within your repository.

You can find the list of default labels in the GitHub documentation.

How to Create a Label in Your Repository

Creating a custom label in the repository is very simple. There are different ways to make a label. You need to follow these common steps:

Go to your repository > then go to issues > then click on the labels button.

Go to Label Page.

Next, click on the new label button and enter your label name, description and color.

Create the label in Github.

How to Delete and Edit Labels on GitHub

To edit and delete a label, go to the issue page and click on the Label button. In the label page, you should see all the existing labels.

Click on the Edit button to edit a label, and click on the Delete button to delete a label.

Edit and delete the Label

You cannot delete multiple labels with GitHub.

How to Use GitHub Projects

Project page

The Github Projects tool is a versatile and flexible tool for planning and managing your repository work in one central location.

It functions similarly to a spreadsheet, task board, and road map, allowing you to plan and track your repository work in one place. The GitHub project is fully integrated with GitHub.

You can create and customize multiple views, filter, sort, and group your issues and pull requests, visualize work with charts, and add custom fields to track specific metadata.

You can assign users to specific issues, check issue statuses, and assign reviewers, among other functions.

GitHub projects come in two types: public and private.

  • Public projects are visible to everyone, and the management team can make edits and changes to the project.

  • Private projects, on the other hand, are not visible to others, and only the management team can edit and make changes to the project.

By default, projects are private in GitHub.

How to Create Projects on GitHub

Creating a project is a straightforward task. In some cases, the projects tab may not be visible on your repository. First, go to your repository section and enable the project.

Enable the Project Tab in the Github.

After enabling projects on your repository, you should now be able to see a projects tab in your repository. Now click on the projects tab.

Click on the Project Tab

Your default project page looks like this. To create a new project, click on the dropdown icon and select the New Project, then click on the New Project option.

Create a new project

Next, select the templates for the project according to your requirements. Click on the view all button to view all available templates, or go with blank templates.

The template comes with pre-configuration based on what you choose.

Select the template for your project.

I selected the feature release template for this tutorial. Next, enter your project name and click on the Create Project button.

Create a project with the selected template.

Your project should be created based on the template you chose. Your project dashboard page may be different according to your template.

Your project dashboard looks like this.

How to Delete and Edit Projects on GitHub

To edit and delete a project, go to the project page.

GitHub projects page

Then click on a project which you want to edit or delete. Clicking on the project title should take you to the project setting page.

Project page

In the project settings page, you can edit the project title and description, delete the project, close the project and also change the visibility of your project from private to public.

Project settings page

How to Use Milestones on GitHub

Milestones in Github

The milestone feature allows you to track the progress of issues or pull requests in a repository. With milestones, you can prioritize open issues and pull requests and set a due date for a group of related items.

In simple terms, milestones operate like a to-do list, where you can detail the amount of completed or pending work. It functions like a progress bar, helping your team manage the project more effectively and communicate the importance of specific issues to both your team and the open-source community.

Milestones allows the open-source community and your team to understand the status of completed or pending work, and the timeline for upcoming versions.

How to Create Milestones on GitHub

First, go to the repository and then to the issue page. Click on the milestones button.

Click on the Milestones button.

Now, you should see your exciting milestones list. To create milestones, click on the new milestones button.

Click on the New Milestones button to create a Milestone.

Enter the milestone title, due date and description and last, then click on the Create milestones button to make your milestone.

Create a new milestone in Github

By default, your created milestone should look like this:

Enter information about milestones.

Our next task is to assign an issue to the milestone. Go to the issue and assign a milestone to it.

Assign the milestone into a issue

If you have multiple milestones, you can select one of them.

Select the milestone

Verify whether the issue is attached or not to the milestone.

Verify whether the issue is attached or not to the milestone.

Now, you can attach or assign multiple issues with a single milestone. When you visit the milestone, you can see all the assigned milestone lists.

Assigned milestone lists.

If you and your teammate close the issue, your progress bar is increased automatically. This can help your team and your community understand how much work has been completed.

The progress bar increased automatically in milestones.

How to Delete and Edit Milestones on GitHub

To edit and delete the milestones, you need to go to the issues page and click on the milestones button to see the available milestones.

To edit milestones, click on the edit button, and to delete the milestones, click on the delete button.

Edit and delete the milestone

Conclusion

Labels, projects, and milestones are basic features useful for managing a project on GitHub. When you use them, you automatically learn about them.

Both milestones and projects are different, and you can not compare both at the same time because both provide different functionalities and working.

As I mentioned, a milestone is used to allow you to track the progress of issues or pull requests in a repository. On the other hand, a project is used to plan and manage your repository from one central location.

For small teams, I recommend milestones, and for the large team, I recommend using projects. You can also use both projects and milestones for better productivity.

I've written other article related to GitHub, and you can check them out here:

  • https://www.freecodecamp.org/news/what-is-github-wiki-and-how-do-you-use-it/

  • https://www.freecodecamp.org/news/github-flavored-markdown-syntax-examples/

  • https://www.freecodecamp.org/news/how-to-run-github-actions-locally/

Source: freecodecamp.org

Related stories
1 month ago - In this step-by-step tutorial, you'll learn how to create an installable Django app. You'll cover everything you need to know, from extracting your app from a Django project to turning it into a package that's available on PyPI and...
1 month ago - Serverless computing emerged as a response to the challenges of traditional server-based architectures. With serverless, developers no longer need to manage or scale servers manually. Instead, cloud providers handle infrastructure...
2 days ago - What is pip? In this beginner-friendly tutorial, you'll learn how to use pip, the standard package manager for Python, so that you can install and manage packages that aren't part of the Python standard library.
3 weeks ago - This tutorial covers how to write a Python web crawler using Scrapy to scrape and parse data, and then store the data in MongoDB.
3 weeks ago - Learn about Zustand's simplistic approach to managing state and how it compares to existing tools such as Mobx and Redux. The post Zustand adoption guide: Overview, examples, and alternatives appeared first on LogRocket Blog.
Other stories
1 hour ago - Ubuntu 24.10 ‘Oracular Oriole’ is released on October 13th, and as you’d expect from a new version of Ubuntu, it’s packed with new features. As a short-term release, Ubuntu 24.10 gets 9 months of ongoing updates, security patches, and...
3 hours ago - Did you know that CSS can play a significant role in web accessibility? While CSS primarily handles the visual presentation of a webpage, when you use it properly it can enhance the user’s experience and improve accessibility. In this...
4 hours ago - Design thinking workshops are your key to turning big problems into clear solutions. In this blog, I share how to run them efficiently and keep your team aligned. The post How to run a design thinking workshop appeared first on LogRocket...
4 hours ago - New memory-optimized X8g instances offer up to 3 TiB DDR5 memory, 192 vCPUs, and 50 Gbps network bandwidth, designed for memory-intensive workloads like databases, analytics, and caching with unparalleled price/performance and efficiency.
4 hours ago - Gain indispensable data engineering expertise through a hands-on specialization by DeepLearning.AI and AWS. This professional certificate covers ingestion, storage, querying, modeling, and more.