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

Add maintainer oriented documentation with guidelines and expectations for "good first issue" and "help wanted" issues #2340

Closed
sarayourfriend opened this issue Jun 7, 2023 · 0 comments · Fixed by #3889
Assignees
Labels
📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: mgmt Related to repo management and automations

Comments

@sarayourfriend
Copy link
Collaborator

sarayourfriend commented Jun 7, 2023

Problem

#2155 identifies new guidelines and expectations we should follow for issues labelled "good first issue" or "help wanted". We need to codify these into documentation that can be referenced and shared. Additionally, we should add templates or other tools for maintainers to use that prompt for each piece of information expected to be present on these issues.

Description

Add a new documentation page that describes the guidelines and expectations for issues labelled "good first issue" or "help wanted". Refer to the discussion linked above. The new document created for this issue should be primarily geared towards maintainers and a separate issue will handle updating/adding documentation for new and ongoing contributors.

The document should cover the following:

  • Boilerplate text for "how do I get help working on this issue"
  • How to identify a "good first issue", "help wanted", no label, and "staff only" issue
  • How to pick the technology labels for "good first issue" and "help wanted" issues
  • Tips for sufficiently describing the change required to close the issue keeping in mind the label context (good first issue vs help wanted, etc)
    • Include prompts to record or link to Openverse domain-specific documentation if relevant
    • Include prompts to link to relevant pieces of code or related PRs as examples
    • Include prompts to link to external documentation related to the technology labels if appropriate

Note that #2341 will add documentation with a contributor focus, but some of this information may be able to be recorded in a single format approachable for anybody. Feel free to adapt, move or link between these two issues when it makes sense, so long as the context is appropriate.

@sarayourfriend sarayourfriend added 🟨 priority: medium Not blocking but should be addressed soon 🌟 goal: addition Addition of new feature 📄 aspect: text Concerns the textual material in the repository 🧱 stack: mgmt Related to repo management and automations labels Jun 7, 2023
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Openverse Backlog Jun 7, 2023
@zackkrida zackkrida added 🟧 priority: high Stalls work on the project or its dependents and removed 🟨 priority: medium Not blocking but should be addressed soon labels Mar 1, 2024
@zackkrida zackkrida moved this from 📋 Backlog to 📅 To Do in Openverse Backlog Mar 1, 2024
@zackkrida zackkrida self-assigned this Mar 4, 2024
@openverse-bot openverse-bot moved this from 📅 To Do to 🏗 In Progress in Openverse Backlog Mar 8, 2024
zackkrida added a commit that referenced this issue Mar 21, 2024
zackkrida added a commit that referenced this issue Mar 25, 2024
zackkrida added a commit that referenced this issue Mar 31, 2024
zackkrida added a commit that referenced this issue Apr 8, 2024
@openverse-bot openverse-bot moved this from 🏗 In Progress to ✅ Done in Openverse Backlog Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: mgmt Related to repo management and automations
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants