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

[Practitioner Guide]: Security #22

Open
geekygirldawn opened this issue Feb 5, 2024 · 5 comments
Open

[Practitioner Guide]: Security #22

geekygirldawn opened this issue Feb 5, 2024 · 5 comments
Assignees
Labels
help wanted Extra attention is needed from somebody practitioner guide

Comments

@geekygirldawn
Copy link
Member

geekygirldawn commented Feb 5, 2024

Practitioner Guide Topic (1 - 3 words)

Security

Primary Metrics (2 - 4 metrics)

  • Release Frequency
  • libyears
  • Change Requests
  • OpenSSF Best Practices Badge

Why is this topic important? How will this help people improve their open source project and / or community? Who will benefit from this guide?

Security is an important concern for all technology projects, including open source ones, and it's important to regularly assess the security of the projects we are working on to improve the security of our projects, but it's also important for the people who are using or considering using a project to assess the viability of that project from a security perspective.

How would you like to see this guide developed?

I am interested in using this guide, but I do not want to write it myself.

Additional Notes

Here is the doc where this guide will be developed: https://docs.google.com/document/d/1ZcUHO6-HycOQtIj6_vPgSb0ageYdmYuGetlRESnF9BE/edit

For an example of a nearly finished Insight Guide that you can use to better understand what should be in each section and how much detail to include, please see the Responsiveness guide.

@sduenas
Copy link
Member

sduenas commented Feb 5, 2024

Security is a wide concept. Should the name of the insight guide specify what parts of security it will address? Or the idea is to start with something generic and later break down the guide into several ones?

@geekygirldawn
Copy link
Member Author

The idea behind the Insight Guides (at least for right now) is to help people get started with metrics. We know that people are overwhelmed; they don't know where to start; and they don't know what to do with the output of the metrics when they have them. For security, we want to put together something that helps them start to understand how to assess security for a project from a general standpoint with the idea that they will hopefully be able to take it to the next step and expand beyond what we have to explore other security topics. My concern is that if we make the guides too detailed or too complicated by trying to address all possible security topics, people might become overwhelmed by the guides as well :)

@sduenas
Copy link
Member

sduenas commented Feb 5, 2024

Got it. I totally agree with you on the purpose of this guide. If you can find a better name for the guide, I think it will help better to understand its purpose and domain but for now, that can be enough :)

@geekygirldawn geekygirldawn changed the title [Insight Guide]: Security [Practitioner Guide]: Security Mar 19, 2024
@geekygirldawn geekygirldawn added the help wanted Extra attention is needed from somebody label Apr 11, 2024
@geekygirldawn geekygirldawn self-assigned this May 30, 2024
@geekygirldawn
Copy link
Member Author

The first draft of this guide is completed. Currently looking for feedback on the draft. https://docs.google.com/document/d/1ZcUHO6-HycOQtIj6_vPgSb0ageYdmYuGetlRESnF9BE/edit

@germonprez
Copy link
Contributor

@geekygirldawn -- I've made a few suggestions to the document.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed from somebody practitioner guide
Projects
None yet
Development

No branches or pull requests

3 participants