diff --git a/partnerships/how-to-guides/github-issues.md b/partnerships/how-to-guides/github-issues.md new file mode 100644 index 00000000..28e5e2fc --- /dev/null +++ b/partnerships/how-to-guides/github-issues.md @@ -0,0 +1,38 @@ +# How do I open a GitHub issue with Engineering? + +This page describes how you can open a general GitHub issue with the {team}`Engineering Team`, for example, to report a failing CI workflow, ask for a feature enhancement or even deploy a new Hub. In this guide, we will be using the {doc}`../../projects/managed-hubs/showcase-hub` as our example GitHub repo. + +## Steps + +1. Navigate to the Community Showcase [GitHub repo](https://github.com/2i2c-org/community-showcase). +2. Under the Issues tab, click **New issue**. + +```{image} ../media/github-issues/01-new-issue.png +:alt: Screenshot of the GitHub issues webpage, highlighting the New issue button. +``` + +3. If applicable, select the most appropriate GitHub issue template (or open a blank issue). In this example, we use the 💡 **General Issue** template. + +4. Fill out the template + + - Populate the text input fields. Try to be concise while providing as much technical detail as you can. For complicated issues, providing a Minimal Working Example and relevant error messages from output logs where possible is a great help. Use code blocks and avoid pasting screenshots of code. + - Use the **Assignees** field on the right-hand side to assign it to the Engineering {role}`Project Manager` to be triaged. + - In the **Labels** field on the right-hand side, choose *one* relevant issue type: {bdg-info}`type: enhancement`, {bdg-info}`type: bug`, or {bdg-info}`type: task`. + - Add the **Engineering and Product Backlog** board to the *Projects* field on the right-hand side. + +```{image} ../media/github-issues/02-general-issue.png +:alt: Screenshot of a General issue template, with title, context, and optional proposal, updates and actions text input fields. +``` +5. Click **Submit new issue**. + +## Further References + +- This guide followed the example of Showcase Hub Issue [#51](https://github.com/2i2c-org/community-showcase/issues/51). +- See [GitHub Docs - Creating an Issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) for a more complete reference guide to creating issues. + +More detailed information from the {team}`Engineering Team`: + +- {doc}`../../engineering/workflow` +- {doc}`../../engineering/reviewing` +- {doc}`../../engineering/github-conventions` +- {doc}`../../engineering/styleguide` diff --git a/partnerships/how-to.md b/partnerships/how-to.md new file mode 100644 index 00000000..bb8d7c77 --- /dev/null +++ b/partnerships/how-to.md @@ -0,0 +1,8 @@ +# How-To Guides + +These sections catalogue how-to guides for partnership specific processes. + +```{toctree} +:glob: +how-to-guides/* +``` diff --git a/partnerships/index.md b/partnerships/index.md index d8179f33..a5293788 100644 --- a/partnerships/index.md +++ b/partnerships/index.md @@ -10,4 +10,5 @@ workflow.md ../communication/index.md community_success/freshdesk.md stickers.md +how-to.md ``` diff --git a/partnerships/media/github-issues/01-new-issue.png b/partnerships/media/github-issues/01-new-issue.png new file mode 100644 index 00000000..ca4464b0 Binary files /dev/null and b/partnerships/media/github-issues/01-new-issue.png differ diff --git a/partnerships/media/github-issues/02-general-issue.png b/partnerships/media/github-issues/02-general-issue.png new file mode 100644 index 00000000..d5b9f451 Binary files /dev/null and b/partnerships/media/github-issues/02-general-issue.png differ diff --git a/partnerships/workflow.md b/partnerships/workflow.md index 257fbc04..0c0f7d99 100644 --- a/partnerships/workflow.md +++ b/partnerships/workflow.md @@ -59,7 +59,7 @@ An exploded tree-view of the Partnerships folder: 2i2c uses GitHub to manage code and infrastructure with version control. 2i2c and partner communities collaborate on managed services, software development, documentation, and sharing of responsibilities using GitHub issues. -Infrastructure services operated by 2i2c are managed through the [infrastructure repository](https://github.com/2i2c-org/infrastructure/). Technical exchanges leading to the deployment of new hubs for partner communities mostly take place in [issues in the infrastructure repo](https://github.com/2i2c-org/infrastructure/issues). +Infrastructure services operated by 2i2c are managed through the [infrastructure repository](https://github.com/2i2c-org/infrastructure/). Technical exchanges leading to the deployment of new hubs for partner communities mostly take place in [issues in the infrastructure repo](https://github.com/2i2c-org/infrastructure/issues). See {doc}`./how-to-guides/github-issues` ### AirTable