Conversation
|
@robrwo you might want to review this one too |
|
Some comments:
|
@robrwo I have clarified some of the pod. The security_contact is meant to allow you to override the author. When I take over a module I don't like to change the author in the dist.ini (or elsewhere). This allows me to say instead of the author use the provided security contact. The report_url overrides both so I clarified that. I should probably make the test for security contact demonstrate that the report_url will override both. |
sjn
left a comment
There was a problem hiding this comment.
Added a few comment around the interactions between security_contact, report_url and maintainer. I'm thinking some of this could be made a little clearer? :-)
|
|
||
| the current maintainer for the distribution; B<Required> | ||
|
|
||
| if a security_contact is defined it will override the maintainer. |
There was a problem hiding this comment.
This text is maybe a bit ambiguous? I'm wondering it may be useful to offer answers to the question "What happens if I don't set this value?".
If the
security_contactfield is defined, it will be presented as the primary contact point for security issues. Themaintainerfield will remain for as a contact point for other issues. If unset, themaintainerremains presented as the primary contact point for all issues.
Same would go for report_url.
|
|
||
| The B<report_url>, if defined, will override both the B<maintainer> | ||
| and B<security_contact> (if defined) | ||
|
|
There was a problem hiding this comment.
Likewise as above,
If the
report_urlfield is defined, it will be presented as the primary contact point for security issues. Themaintainerfield will continue to be presented as a contact point for other issues.
If unset, themaintainerremains presented as the primary contact point for all issues.
If thesecurity_contactfield is also set, it will be offered as an secondary contact point for security issues.
Does this make sense?
I have noticed that having a security_contact option would be useful.
Dist::Zilla::Plugin::SecurityPolicy could then specify:
that would then overide the author(s)