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

(doc) Add security.md file #1902

Merged
merged 1 commit into from
Oct 16, 2019
Merged

Conversation

gep13
Copy link
Member

@gep13 gep13 commented Aug 21, 2019

This addition, changes the following:

image

To this:

image

Which, once you click on it, show the policy, rather than starting to create a new issue:

image

We might want to expand on the content a little bit. For example, this is what @AdmiringWorm (who I am stealing the idea from) is using:

https://github.com/WormieCorp/.github/blob/master/.github/SECURITY.md

And also another example here:

https://github.com/standard/.github/blob/master/SECURITY.md

Thoughts?

This replaces that current issue template that we have specifically for
security related issues.  Instead of starting to create a new issue,
which is what happens currently, this will simply display the policy
to the user.
Copy link
Member

@pauby pauby left a comment

Choose a reason for hiding this comment

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

I like the change. Makes it much clearer. One thought - It may be better to be at the top so people don't just stop at the first one they find that might match (likely raising a normal issue) rather than going through the whole list?

@gep13
Copy link
Member Author

gep13 commented Aug 21, 2019

@pauby I actually thought the same. but from what I can see, I don't think we can control that 😢

@pauby
Copy link
Member

pauby commented Aug 21, 2019

@gep13 I thought we could. I think you can do it by naming the templates so they sit in alphabetical order you need - see https://github.com/chocolatey-community/chocolatey-package-requests/tree/master/.github/ISSUE_TEMPLATE

@gep13
Copy link
Member Author

gep13 commented Aug 21, 2019

@pauby yes, but this file that I just added, sits outside the ISSUE_TEMPLATE folder. It is at the root of the .github folder.

@gep13
Copy link
Member Author

gep13 commented Aug 21, 2019

So, it's not technically an issue template, since it appears elsewhere in the GitHub UI.

@gep13
Copy link
Member Author

gep13 commented Aug 21, 2019

@ferventcoder as a side note, we have the often of moving these files (once we are happy with them) to a new .github folder within the chocolatey organisation, and they would be applied to all repositories under this Organisation.

@pauby
Copy link
Member

pauby commented Aug 21, 2019

@pauby yes, but this file that I just added, sits outside the ISSUE_TEMPLATE folder. It is at the root of the .github folder.

To be fair, I did not check that 😄

Copy link

@adilio adilio left a comment

Choose a reason for hiding this comment

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

Looks good to me! Much clearer!

@AdmiringWorm
Copy link
Member

I would also recommend adding a link to the security policy in the README.md (actually, github recommends it), as well as perhaps in the contribution guidelines.

@ferventcoder
Copy link
Member

LGTM!

@ferventcoder ferventcoder merged commit 3b10e75 into chocolatey:master Oct 16, 2019
@ferventcoder ferventcoder self-assigned this Oct 16, 2019
@gep13 gep13 deleted the security_policy branch October 16, 2019 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants