*: Pull in project-template 61d73a3 #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Seed this new project with the template, as specified in the TOB proposal [1]. My personal preference is to merge to preserve the history and make future updates easier. But I've had trouble with that in the past [2], so this commit drops the template history. Generated with: $ git remote add project-template git://github.com/opencontainers/project-template.git $ git fetch project-template $ git show --oneline project-template/master 61d73a3 (project-template/master) Merge pull request opencontainers#40 from wking/minor-patch-bullet $ git read-tree project-template/master $ git add -A . $ git checkout HEAD -- README.md $ git commit -sv [1]: https://github.com/opencontainers/tob/blob/3619df26faffa123e32a819ae32647a57fce4de2/proposals/distribution.md#governance-and-releases [2]: opencontainers/go-digest#20 (comment) Signed-off-by: W. Trevor King <[email protected]>
The other groups make sense for project-template, but we only need one set here. Signed-off-by: W. Trevor King <[email protected]>
mikebrow
reviewed
Apr 4, 2018
MAINTAINERS
Outdated
| @@ -0,0 +1,8 @@ | |||
| This meta-project is maintained by the union of MAINTAINERS for all OCI Projects [1]. | |||
There was a problem hiding this comment.
distribution-spec-maintainers..
There was a problem hiding this comment.
distribution-spec-maintainers..
Thanks, I've pushed 1c81711 to fix that.
Pulling the values from [1] and alphabetizing by first name. [1]: https://github.com/opencontainers/tob/blob/3619df26faffa123e32a819ae32647a57fce4de2/proposals/distribution.md#initial-maintainers Signed-off-by: W. Trevor King <[email protected]>
wking
added a commit
to wking/distribution-spec
that referenced
this pull request
Apr 10, 2018
CONTRIBUTING.md (which we got from project-template in be21fe9 (*: Pull in project-template 61d73a3, 2018-04-04, opencontainers#3) covers this same space. Dropping the contrib docs from the README (and instead linking to CONTRIBUTING.md) keeps us DRY (vs. having the content in each location), gets us the GitHub contributing UI improvements [1] (vs. having the content only in the README), keeps the information discoverable (vs. having the content only in CONTRIBUTING and not linking from the README), and gives us more space in the README to talk about the project itself (contributing docs are only useful for a subset of README readers). [1]: https://help.github.com/articles/setting-guidelines-for-repository-contributors/ Signed-off-by: W. Trevor King <[email protected]>
wking
added a commit
to wking/distribution-spec
that referenced
this pull request
Apr 10, 2018
CONTRIBUTING.md (which we got from project-template in be21fe9, *: Pull in project-template 61d73a3, 2018-04-04, opencontainers#3) covers this same space. Dropping the contrib docs from the README (and instead linking to CONTRIBUTING.md) keeps us DRY (vs. having the content in each location), gets us the GitHub contributing UI improvements [1] (vs. having the content only in the README), keeps the information discoverable (vs. having the content only in CONTRIBUTING and not linking from the README), and gives us more space in the README to talk about the project itself (contributing docs are only useful for a subset of README readers). [1]: https://help.github.com/articles/setting-guidelines-for-repository-contributors/ Signed-off-by: W. Trevor King <[email protected]>
wking
added a commit
to wking/distribution-spec
that referenced
this pull request
Apr 11, 2018
CONTRIBUTING.md (which we got from project-template in be21fe9, *: Pull in project-template 61d73a3, 2018-04-04, opencontainers#3) covers this same space. Dropping the contrib docs from the README (and instead linking to CONTRIBUTING.md) keeps us DRY (vs. having the content in each location), gets us the GitHub contributing UI improvements [1] (vs. having the content only in the README), keeps the information discoverable (vs. having the content only in CONTRIBUTING and not linking from the README), and gives us more space in the README to talk about the project itself (contributing docs are only useful for a subset of README readers). I've copy/pasted the CONTRIBUTING.md content for issues and the mailing list into the README at Stephen's request [2]. Personally I don't have a problem with requiring readers to click through to CONTRIBUTING to get this information, but I'm not a maintainer. I am slightly concerned that the copy/pasted discussion channel information is even further from the security-disclosure section (for a paranoid approach, see [3]), but I'll leave addressing that or not up to the maintainers as well. [1]: https://help.github.com/articles/setting-guidelines-for-repository-contributors/ [2]: opencontainers#9 (comment) [3]: opencontainers/project-template#57 Signed-off-by: W. Trevor King <[email protected]>
wking
added a commit
to wking/distribution-spec
that referenced
this pull request
Apr 11, 2018
CONTRIBUTING.md (which we got from project-template in be21fe9, *: Pull in project-template 61d73a3, 2018-04-04, opencontainers#3) covers this same space. Dropping the contrib docs from the README (and instead linking to CONTRIBUTING.md) keeps us DRY (vs. having the content in each location), gets us the GitHub contributing UI improvements [1] (vs. having the content only in the README), keeps the information discoverable (vs. having the content only in CONTRIBUTING and not linking from the README), and gives us more space in the README to talk about the project itself (contributing docs are only useful for a subset of README readers). I've copy/pasted the CONTRIBUTING.md content for issues and the mailing list into the README at Stephen's request [2], turning "Issues" into a link in the process. I've left it as a non-link in CONTRIBUTING.md to stay closer to the upstream project-template, but wouldn't have a problem making it a link there to if the maintainers preferred that. Personally I don't have a problem with requiring readers to click through to CONTRIBUTING to get this information, but I'm not a maintainer. I am slightly concerned that the copy/pasted discussion channel information is even further from the security-disclosure section (for a paranoid approach, see [3]), but I'll leave addressing that or not up to the maintainers as well. [1]: https://help.github.com/articles/setting-guidelines-for-repository-contributors/ [2]: opencontainers#9 (comment) [3]: opencontainers/project-template#57 Signed-off-by: W. Trevor King <[email protected]>
wking
added a commit
to wking/distribution-spec
that referenced
this pull request
Apr 11, 2018
CONTRIBUTING.md (which we got from project-template in be21fe9, *: Pull in project-template 61d73a3, 2018-04-04, opencontainers#3) covers this same space. Dropping the contrib docs from the README (and instead linking to CONTRIBUTING.md) keeps us DRY (vs. having the content in each location), gets us the GitHub contributing UI improvements [1] (vs. having the content only in the README), keeps the information discoverable (vs. having the content only in CONTRIBUTING and not linking from the README), and gives us more space in the README to talk about the project itself (contributing docs are only useful for a subset of README readers). I've copy/pasted the CONTRIBUTING.md content for issues and the mailing list into the README at Stephen's request [2], turning "Issues" into a link in the process and making some other minor copy-edits. I've left it as a non-link in CONTRIBUTING.md to stay closer to the upstream project-template, but wouldn't have a problem making it a link there to if the maintainers preferred that. I've also added a security reference based on my in-flight [3], also at Stephen's request [4]. Personally I don't have a problem with requiring readers to click through to CONTRIBUTING to get this information (as long as the security information stays close to the information for other channels [3]), but I'm not a maintainer. [1]: https://help.github.com/articles/setting-guidelines-for-repository-contributors/ [2]: opencontainers#9 (comment) [3]: opencontainers/project-template#57 [4]: opencontainers#9 (comment) Signed-off-by: W. Trevor King <[email protected]>
sudo-bmitch
pushed a commit
to sudo-bmitch/distribution-spec
that referenced
this pull request
Aug 1, 2022
Temporarily remove conformance changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Seed this new project with the template, as specified in the TOB proposal. My personal preference is to merge to preserve the history and make future updates easier. But I've had trouble with that in the past (e.g. here), so this commit drops the template history.
I've localized .pullapprove.yml and kept @caniszczyk's README, but otherwise left project-template alone (EDIT: I've also updated
MAINTAINERS). I expect the maintainers here will want to land some of the remaining in-flight project-template improvements once they take over (e.g. the broken security-issues link, opencontainers/project-template#34). But I've left those off this PR to be as unopinionated as possible.Fixes #1.