Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Partnerships] Document a short how-to guide for opening a GH issue #792

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions partnerships/how-to-guides/github-issues.md
Original file line number Diff line number Diff line change
@@ -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`
8 changes: 8 additions & 0 deletions partnerships/how-to.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# How-To Guides

These sections catalogue how-to guides for partnership specific processes.

```{toctree}
:glob:
how-to-guides/*
```
1 change: 1 addition & 0 deletions partnerships/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ workflow.md
../communication/index.md
community_success/freshdesk.md
stickers.md
how-to.md
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion partnerships/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down