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

instructions for requesting new packages #655

Merged
merged 1 commit into from
Oct 28, 2020

Conversation

miabbott
Copy link
Member

An initial set of instructions on how to request a new package be
added to FCOS. This can be folded into a chooser option for new
issues, if desired.

Closes #641

Copy link
Member

@jlebon jlebon left a comment

Choose a reason for hiding this comment

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

Thanks for writing this up! One minor/optional comment; LGTM as is too.

NEWPACKAGE.md Outdated Show resolved Hide resolved
@miabbott miabbott force-pushed the pkg_questions branch 2 times, most recently from 40ed965 to afeb470 Compare October 27, 2020 16:57
Copy link
Member

@jlebon jlebon left a comment

Choose a reason for hiding this comment

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

LGTM! Will let @dustymabe have a look.

Copy link
Member

@dustymabe dustymabe left a comment

Choose a reason for hiding this comment

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

Mostly LGTM. Just some wording suggestions.

NEWPACKAGE.md Outdated
1. What, if any, are the additional dependencies on the package? (i.e. does it drag in Python, Perl, etc)
2. What is the size of the package and its dependencies?
3. What problem are you trying to solve with this package? Or what functionality does the package provide?
4. Can the package be run from a container? Explain why or why not.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
4. Can the package be run from a container? Explain why or why not.
4. Can the software provided by the package be run from a container? Explain why or why not.

NEWPACKAGE.md Outdated
2. What is the size of the package and its dependencies?
3. What problem are you trying to solve with this package? Or what functionality does the package provide?
4. Can the package be run from a container? Explain why or why not.
5. Can the tool be helpful in debugging container runtime issues?
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
5. Can the tool be helpful in debugging container runtime issues?
5. Can the tool(s) provided by the package be helpful in debugging container runtime issues?

NEWPACKAGE.md Outdated
3. What problem are you trying to solve with this package? Or what functionality does the package provide?
4. Can the package be run from a container? Explain why or why not.
5. Can the tool be helpful in debugging container runtime issues?
6. Can the tool be helpful in debugging networking issues?
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
6. Can the tool be helpful in debugging networking issues?
6. Can the tool(s) provided by the package be helpful in debugging networking issues?

NEWPACKAGE.md Outdated
5. Can the tool be helpful in debugging container runtime issues?
6. Can the tool be helpful in debugging networking issues?
7. Is it possible to layer the package onto the base OS as a day 2 operation? Explain why or why not.
8. Can the packaging be adjusted to just deliver binaries?
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
8. Can the packaging be adjusted to just deliver binaries?
8. In the case of packages providing services and binaries, can the packaging be adjusted to just deliver binaries?

NEWPACKAGE.md Outdated
6. Can the tool be helpful in debugging networking issues?
7. Is it possible to layer the package onto the base OS as a day 2 operation? Explain why or why not.
8. Can the packaging be adjusted to just deliver binaries?
9. Can the tool be used to do things we’d rather users not be able to do in FCOS? (e.g. can it be abused as a Turing complete interpreter?)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
9. Can the tool be used to do things we’d rather users not be able to do in FCOS? (e.g. can it be abused as a Turing complete interpreter?)
9. Can the tool(s) provided by the package be used to do things we’d rather users not be able to do in FCOS? (e.g. can it be abused as a Turing complete interpreter?)

NEWPACKAGE.md Outdated
7. Is it possible to layer the package onto the base OS as a day 2 operation? Explain why or why not.
8. Can the packaging be adjusted to just deliver binaries?
9. Can the tool be used to do things we’d rather users not be able to do in FCOS? (e.g. can it be abused as a Turing complete interpreter?)
10. Does the tool have a history of CVEs?
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
10. Does the tool have a history of CVEs?
10. Do the software provided by the package have a history of CVEs?

Copy link
Contributor

Choose a reason for hiding this comment

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

Should be "Does the software...", no?

Copy link
Contributor

@bgilbert bgilbert left a comment

Choose a reason for hiding this comment

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

Thanks for doing this!

I'm in favor of adding the questionnaire as a new-issue template in the chooser rather than a separate NEWPACKAGE.md file. Without that, I suspect users will file ordinary feature requests anyway, and we'll have to refer them back to the instructions.

NEWPACKAGE.md Outdated

Please title the new issue: `Package Request: <name of package>`

1. What, if any, are the additional dependencies on the package? (i.e. does it drag in Python, Perl, etc)
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: nicer phrasing:

Suggested change
1. What, if any, are the additional dependencies on the package? (i.e. does it drag in Python, Perl, etc)
1. What, if any, are the additional dependencies on the package? (i.e. does it pull in Python, Perl, etc)

NEWPACKAGE.md Outdated
7. Is it possible to layer the package onto the base OS as a day 2 operation? Explain why or why not.
8. Can the packaging be adjusted to just deliver binaries?
9. Can the tool be used to do things we’d rather users not be able to do in FCOS? (e.g. can it be abused as a Turing complete interpreter?)
10. Does the tool have a history of CVEs?
Copy link
Contributor

Choose a reason for hiding this comment

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

Should be "Does the software...", no?

An initial set of instructions on how to request a new package be
added to FCOS. This can be folded into a chooser option for new
issues, if desired.

Closes coreos#641
@miabbott
Copy link
Member Author

Thanks for the feedback Dusty + Benjamin! I've pushed a new update.

Re: the new issue chooser - I'd say let's merge these changes as is (just so we agree on wording) and afterwards I'll setup the chooser. It won't hurt to have the file around, IMO.

Copy link
Member

@dustymabe dustymabe left a comment

Choose a reason for hiding this comment

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

LGTM

@miabbott miabbott merged commit a942208 into coreos:master Oct 28, 2020
miabbott added a commit that referenced this pull request Oct 28, 2020
I took a guess at what would be good for the bug report template.  The new package template is taken from #655.
miabbott added a commit that referenced this pull request Oct 28, 2020
* Bug Report + New Package templates

I took a guess at what would be good for the bug report template.  The new package template is taken from #655.

Co-authored-by: Dusty Mabe <[email protected]>
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.

Template/questionnaire for requesting packages to base OS
4 participants