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

GitHub for Maintainers #1

Open
tobyhodges opened this issue Oct 20, 2023 · 1 comment
Open

GitHub for Maintainers #1

tobyhodges opened this issue Oct 20, 2023 · 1 comment

Comments

@tobyhodges
Copy link

Background

(Based on a conversation at OLS co-working, with @sgibson91.)

I recently finished drafting a skill-up for Carpentries lesson Maintainers that teaches:

  • issue triage (labels, assignments)
  • pull request reviews (line-by-line commenting, suggesting changes, "Request Changes" vs "Approve")
  • resolving merge conflicts in the browser
  • (plus ad-hoc discussion of Actions, Web Editor, milestones/project boards, ... that is not in the curriculum)

The source repository includes automation to create duplicate example repositories for people to use while following the skill-up.

Project Idea

We would like to create a "deCarpentriesified" version that would feel more authentic to people who maintain non-lesson repositories. This would involve:

  • identifying/expanding list of skills to be taught
  • designing an example repository
  • defining authentic tasks to help teach the relevant skills and concepts
  • creating branches, issue/pull request boilerplate, and workflow(s) to enable automated creation of example repositories for use during the skill-up

Who is this for?

The ideal project members would have experience in:

  • GitHub, ideally as a project maintainer
  • interacting with REST APIs

They would find motivation in:

  • teaching new skills to people
  • promoting inclusive practices in open source
@sayantikabanik
Copy link

sayantikabanik commented Nov 30, 2024

Love the outline 😀

Few other ideas (happy to chime in, help co-create content/present)

  • Introduction to project boards and effectively linking those to issues via automation
  • Setting up pre-commit hooks
  • Env management and more with GHA
  • vale.sh intro, great addition for PR reviews

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants