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

Expand contributor oriented documentation related to finding issues to work on #2341

Open
sarayourfriend opened this issue Jun 7, 2023 · 0 comments
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: mgmt Related to repo management and automations

Comments

@sarayourfriend
Copy link
Collaborator

Problem

#2155 identifies ways in which the contributor documentation should be improved to make it more accessible, both for new and ongoing contributors.

Description

Update the existing contributing docs to include the following:

  • A more explicit invitation to work on multiple issues labelled "good first issue" (move this closer to the top)
  • An explanation of what contributors can expect from issues labelled "good first issue" and "help wanted" (and issues with no label at all) and how they relate to the technology labels
  • A list of pre-defined queries to find issues to work on separated by technology and "good first issue"/"help wanted"/no label. Examples:
    • Good introductions to automated testing
    • Good introductions to JavaScript
    • Good introductions to Python
    • Good introductions to Airflow
    • Good introductions to Django (Rest Framework)
    • Advanced automated testing
    • Advanced JavaScript
    • Advanced Python
    • etc, if there are more or if these don't make sense/have too few issues, we can iterate on this list and keep it flexible

Note that #2340 will add documentation with a maintainer 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: improvement Improvement to an existing user-facing 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
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: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: mgmt Related to repo management and automations
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant