|
| 1 | +--- |
| 2 | +title: A guide on GitHub Projects |
| 3 | +date: 2024-12-12 |
| 4 | +lastUpdated: 2024-12-12 |
| 5 | +tags: [github, github-projects-v2] |
| 6 | +excerpt: How to master GitHub Projects? |
| 7 | +cover: |
| 8 | + image: /src/assets/blog/a-guide-on-github-projects/default-view.png |
| 9 | + alt: Template Project Preview |
| 10 | +featured: false |
| 11 | +draft: false |
| 12 | +--- |
| 13 | + |
| 14 | +import { LinkCard, Aside, LinkButton, Steps, Icon, Badge } from '@astrojs/starlight/components'; |
| 15 | + |
| 16 | +<Aside type="caution">This guide is only for <a href="https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects" target="_blank">GitHub ProjectsV2!</a></Aside> |
| 17 | + |
| 18 | +<Steps> |
| 19 | + |
| 20 | +1. ## Create a ProjectV2 |
| 21 | + |
| 22 | + With our SCRUM template, |
| 23 | + |
| 24 | + <LinkCard |
| 25 | + title="Propromo's GitHub SCRUM Template" |
| 26 | + href="/en/blog/how-to-use-propromos-github-scrum-template-project" |
| 27 | + description="How to use Propromo's GitHub SCRUM Template Project?" |
| 28 | + /> |
| 29 | + |
| 30 | + or with a GitHub template at<br />`github.com/<username>?tab=projects` or `github.com/orgs/<username>/projects`. |
| 31 | + <img src="/src/assets/blog/a-guide-on-github-projects/project-templates.png" alt="Project Templates" /> |
| 32 | + |
| 33 | + --- |
| 34 | + |
| 35 | + or migrate from ProjectV1: |
| 36 | + |
| 37 | + <LinkButton |
| 38 | + href="https://docs.github.com/en/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic" |
| 39 | + target="_blank" |
| 40 | + variant="secondary" |
| 41 | + icon="external" |
| 42 | + iconPlacement="start" |
| 43 | + > |
| 44 | + GitHub Documentation |
| 45 | + </LinkButton> |
| 46 | + |
| 47 | +2. ## Default View |
| 48 | + |
| 49 | + You are now at `github.com/<orgs|users>/<username>/projects/<id>` |
| 50 | + and can see your default view here. |
| 51 | + |
| 52 | + <a href="https://github.com/orgs/propromo-software/projects/1/views/1" target="_blank"> |
| 53 | + <img src="/src/assets/blog/a-guide-on-github-projects/default-view.png" alt="Default View" /> |
| 54 | + </a> |
| 55 | + |
| 56 | + > Here you can also set the type of **view** as well as some sorting and display options. |
| 57 | +
|
| 58 | + <img src="/src/assets/blog/a-guide-on-github-projects/change-type-sort-and-fields.png" alt="Change Type Sort and Fields" /> |
| 59 | + |
| 60 | + > And [**filter**](https://docs.github.com/en/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). |
| 61 | +
|
| 62 | + <img src="/src/assets/blog/a-guide-on-github-projects/filter.png" alt="Filter" /> |
| 63 | + |
| 64 | + <Aside type="note"> |
| 65 | + GitHub ProjectsV2 has a limitation on the number of displayed sprints. |
| 66 | + This is quite annoying when you want to create an overview of all sprints. |
| 67 | + To work around this, you can simply exclude a sprint that doesn't exist. |
| 68 | + Like this: `-sprint:"thiswillneverbeasprintname"`. |
| 69 | + </Aside> |
| 70 | + |
| 71 | + > There are now also **statistics** for GitHub Projects. |
| 72 | +
|
| 73 | + <img src="/src/assets/blog/a-guide-on-github-projects/insights.png" alt="Insights" /> |
| 74 | + |
| 75 | + `github.com/<orgs|users>/<username>/projects/<id>/insights` |
| 76 | + <img src="/src/assets/blog/a-guide-on-github-projects/insight-settings.png" alt="Insight Settings" /> |
| 77 | + <img src="/src/assets/blog/a-guide-on-github-projects/statistics.png" alt="Statistics" /> |
| 78 | + |
| 79 | + > Settings - Creating custom **Issue Fields** |
| 80 | +
|
| 81 | + `github.com/<orgs|users>/<username>/projects/<id>/settings` |
| 82 | + <img src="/src/assets/blog/a-guide-on-github-projects/settings.png" alt="Settings" /> |
| 83 | + |
| 84 | + > Sprint |
| 85 | +
|
| 86 | + <img src="/src/assets/blog/a-guide-on-github-projects/sprint-settings.png" alt="Sprint Settings" /> |
| 87 | + |
| 88 | + > Status |
| 89 | +
|
| 90 | + <img src="/src/assets/blog/a-guide-on-github-projects/status-settings.png" alt="Status Settings" /> |
| 91 | + |
| 92 | + *Result:* |
| 93 | + <img src="/src/assets/blog/a-guide-on-github-projects/sprint-field.png" alt="Sprint Field" /> |
| 94 | + |
| 95 | + > **Workflows**: How to automatically change issues through actions. |
| 96 | +
|
| 97 | + <img src="/src/assets/blog/a-guide-on-github-projects/workflows.png" alt="Workflows" /> |
| 98 | + |
| 99 | + `github.com/<orgs|users>/<username>/projects/<id>/workflows` |
| 100 | + <img src="/src/assets/blog/a-guide-on-github-projects/workflow-settings.png" alt="Workflow Settings" /> |
| 101 | + |
| 102 | +3. ## How do we organize our GitHub Project? |
| 103 | + |
| 104 | + We assign <Badge text="userstory" variant="note" /> and <Badge text="task" variant="success" /> labels to our issues so we can identify them more quickly. |
| 105 | + Additionally, although we have created a dedicated Sprint field for the issues, we also assign a Sprint label (`sprint-xxx`), |
| 106 | + to keep track in the issues overview where the Sprint field is not displayed. |
| 107 | + |
| 108 | + `github.com/<username>/<repository-name>/issues` |
| 109 | + <img src="/src/assets/blog/a-guide-on-github-projects/issues.png" alt="Issues" /> |
| 110 | + |
| 111 | + `github.com/<username>/<repository-name>/labels` |
| 112 | + <img src="/src/assets/blog/a-guide-on-github-projects/labels.png" alt="Labels" /> |
| 113 | + |
| 114 | + `github.com/<username>/<repository-name>/milestones` |
| 115 | + <img src="/src/assets/blog/a-guide-on-github-projects/milestones.png" alt="Milestones" /> |
| 116 | + |
| 117 | + Since milestones and labels can only be managed per repository in GitHub, |
| 118 | + we recommend using our [propromo.cli](https://github.com/propromo-software/propromo.cli) to synchronize them between repositories. |
| 119 | + |
| 120 | +</Steps> |
| 121 | + |
| 122 | +<div style="display: flex; margin-top: 2rem;"> |
| 123 | + <LinkButton |
| 124 | + href="https://github.com/propromo-software/propromo.cli" |
| 125 | + target="_blank" |
| 126 | + variant="secondary" |
| 127 | + icon="github" |
| 128 | + iconPlacement="start" |
| 129 | + > |
| 130 | + Learn more. |
| 131 | + </LinkButton> |
| 132 | +</div> |
0 commit comments