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 REVIEW.md #297

Closed
wants to merge 1 commit into from
Closed

Conversation

nicholasbishop
Copy link
Contributor

The text here is imported from https://github.com/rhboot/shim/wiki/reviewer-guidelines

I think including this in the repo will help people find it, and also by putting it in git we can do code review on changes, which is harder in the wiki format.

If this is merged we should delete the wiki page's current text and just link to the new location.

@frozencemetery
Copy link
Member

I didn't notice this PR before making some changes to the wiki, so apologies for that. Should be an easy sync, though.

The text here is imported from
https://github.com/rhboot/shim/wiki/reviewer-guidelines

I think including this in the repo will help people find it, and also by
putting it in git we can do code review on changes, which is harder in
the wiki format.
@nicholasbishop
Copy link
Contributor Author

Synced

@steve-mcintyre steve-mcintyre added the meta Not a review request, but an issue or notice wrt the signing process label Sep 18, 2023
@steve-mcintyre
Copy link
Collaborator

I'm more tempted to update the in-source docs to point at the wiki, I'll be honest. Then we can continue to update the docs for guidelines without having to commit changes in the main shim source. How does that sound?

@nicholasbishop
Copy link
Contributor Author

Then we can continue to update the docs for guidelines without having to commit changes in the main shim source.

This PR is into shim-review, not shim. IMO it should be fine to update review guidelines in this repo, and there are some significant advantages to using a real repo rather than the wiki:

  1. PR review. Changes to the wiki just silently appear there, rather than going through the PR process.
  2. Community edit access. Anyone can make a PR, but wikis usually have a more restrictive access controls. If you do open up the wiki to allow non-collaborator access, extra work is needed to moderate the wiki.

@steve-mcintyre
Copy link
Collaborator

Then we can continue to update the docs for guidelines without having to commit changes in the main shim source.

This PR is into shim-review, not shim.

Ah, now I understand you better. Doh! :-)

IMO it should be fine to update review guidelines in this repo, and there are some significant advantages to using a real repo rather than the wiki:

1. PR review. Changes to the wiki just silently appear there, rather than going through the PR process.

2. Community edit access. Anyone can make a PR, but wikis usually have a more restrictive access controls. If you do open up the wiki to [allow non-collaborator access](https://docs.github.com/en/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis), extra work is needed to moderate the wiki.

Fair points, yes. I've been making some more tweaks in the wiki recently, expanding on stuff. I'll push changes across here shortly...

@steve-mcintyre
Copy link
Collaborator

Just opened #344 for that now...

@steve-mcintyre
Copy link
Collaborator

Closing this - basically the same text is now in docs/reviewer-guidelines.md via a roundabout route

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Not a review request, but an issue or notice wrt the signing process
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants