Skip to content

add review instructions and template#1

Open
d-chambers wants to merge 5 commits intomasterfrom
opensource_review
Open

add review instructions and template#1
d-chambers wants to merge 5 commits intomasterfrom
opensource_review

Conversation

@d-chambers
Copy link
Copy Markdown
Member

Hey @sboltz, mind taking a look at this?

Copy link
Copy Markdown
Collaborator

@shawnboltz shawnboltz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few comments. I think it looks pretty reasonable overall.

Comment thread new_project/readme.md Outdated
Comment thread new_project/readme.md
Comment thread new_project/readme.md
@@ -0,0 +1,88 @@
# Github Release Process
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What sort of review process are PRs going to be subjected to? Is it just the owner of the repo, or is it going to have to go much further up the chain?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this question get answered by the issue checklist?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not exactly. That's for a new repository is it not? I'm thinking about a pull request on an existing repository.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, right. I don't know yet, I haven't proposed anything. This PR just proposes a process for releasing new open-source projects. We probably need to address PRs in a different document.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There hasn't been much discussion as of yet regarding this topic, but in my opinion anything that is a "release" of some software/code is going to have a larger stakeholder approval process. Pulling code in, such as these PR's, I would think would be handled at the project team level.

Comment thread new_project/readme.md Outdated
Comment thread new_project/readme.md Outdated
4. The code includes a [testing procedure](#Testing).
5. The code includes an [OSI approved open-source liscense](https://opensource.org/licenses).
6. The code includes a [version string and a versioning system](#Versioning)
7. The code has been uploaded to the niosh-mining github page as a **private** repo.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the person who wants to upload the repo able to make it public without anyone's intervention? Or does it have to be private by default?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can be made public. I don't know if there are any administrative controls which can prevent creating public repos but I will look into it.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like we don't have the right organization account to restrict public repo creation. We need GitHub Enterprise Cloud: https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization

Comment thread new_project/readme.md
Comment thread new_project/readme.md Outdated
Comment thread new_project/approval_template.md
Comment thread new_project/approval_template.md
Comment thread new_project/readme.md Outdated
Expanded on data that shouldn't be included in a repo.
Fixed formatting
@d-chambers
Copy link
Copy Markdown
Member Author

Hey @coolfritz and @GPCole do you guys mind taking a look at this?

Howdy, I've made some edits and suggestions. 

I also agree with the comment I saw in the thread about having a clear process to have a process defined to accept, integrate, and release updated code.

I'm also not quite sure how to word it, but do we want to maintain an "officially vetted" release along with a "latest beta" release so the Github community can help test?

I don't think it belongs in this document, but if an official product ends up using this location as the main distribution point, we should still make sure it has a coversheet so it can be listing on our Mining website.
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

Successfully merging this pull request may close these issues.

4 participants