search

github / github-ospo

Helping open source program offices get started
https://github.blog/2023-03-13-an-open-source-project-to-empower-ospos-everywhere/
MIT License
659 stars 59 forks source link

Update actions readmes/contributing to point back to github-ospo #75

Closed ahpook closed 6 months ago

ahpook commented 7 months ago

Currently the various ospo actions are completely separate and there's not much connective "tissue" between them and the broader efforts to help OSPOs on GitHub. As a first step, we should update their READMEs to headline the rest of the tools and the github/github-ospo repo, plus indicate that PRs about the code in a specific action lives in its repo, but questions about overall usage or feature enhancements should go here instead. The actions are in:

jmeridth commented 7 months ago

@ahpook

Love the link back to this repo (helps inform users there are other GitHub Actions available)

I'm wary of the Issues being back on this repo for all the Actions. Is this for ease of centralization for product and to ensure we keep each repo in "sync" (shared techniques, etc)? I assume so.

This is not the norm for open-source contributation IMO. I'd done something else. I've created a project at the organization level (e.g., OSPO) and when issues are created in each repository we can automate assigning them to that project. Therefore product and maintainers get one location to manage issues. Still gives contributors the "normal" open-source process "feel" but allows product/maintainers to not have to go to each repository. Especially as the repository count grows.

wdyt?

jmeridth commented 7 months ago

Looks like there is already have a project 😄 @ahpook is way ahead of me.

ahpook commented 7 months ago

I'm just getting things set up 👍 but yeah, my thought was that the board should live in github-ospo, along with any issues that are "meta" questions like the ones about unifying config files, requests for new actions etc. But issues related to a specific action should clearly stay in that action's repo.

jmeridth commented 7 months ago

@ahpook What verbiage would you want in the README's for each project so they point back to github.com/github/github-ospo?

Something like:

## Issues and PRs

All feedback regarding our GitHub Actions, as a whole, should be communicated through
[issues on our github-ospo repository](https://github.com/github/github-ospo/issues).

Issues and Pull Requests specific to this GitHub Action should be filed on this repository.

I ask so that I can include it in future PRs to each GitHub Action.

lelia commented 7 months ago

@jmeridth From my POV that phrasing seems fine. My only note would be that perhaps it's worth adding an Issue Template in support of this type of feedback on github-ospo.

jmeridth commented 6 months ago

@ahpook I believe this one is complete. All GitHub Actions READMEs have been updated to point back to this repository for overall issues.

ahpook commented 6 months ago

LGTM! Thanks JM

Kya123iu commented 1 month ago

Currently the various ospo actions are completely separate and there's not much connective "tissue" between them and the broader efforts to help OSPOs on GitHub. As a first step, we should update their READMEs to headline the rest of the tools and the github/github-ospo repo, plus indicate that PRs about the code in a specific action lives in its repo, but questions about overall usage or feature enhancements should go here instead. The actions are in:

  • github/automatic-contrib-prs
  • github/cleanowners
  • github/contributors
  • github/evergreen
  • github/issue-metrics
  • github/stale-repos