Skip to content

Commit

Permalink
Add community engagement links (#468)
Browse files Browse the repository at this point in the history
  • Loading branch information
ahouseholder authored Feb 17, 2024
1 parent 4aff9d7 commit 06a943b
Show file tree
Hide file tree
Showing 10 changed files with 151 additions and 54 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a report to help us improve
title: Add a brief title for your report here
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Platform details**
Include any relevant details like OS, browser, versions, etc.

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: Add a concise title for your request
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: Question
about: Ask the SSVC team a question
title: Add a concise title for your question
labels: question
assignees: ''

---

_Note:_ Questions for the SSVC team can be asked here in the form of an issue. More general questions directed at the SSVC user community
might be a better fit in the [Q&A](https://github.com/CERTCC/SSVC/discussions/categories/q-a) category of our
[Discussions](https://github.com/CERTCC/SSVC/discussions) area.
42 changes: 2 additions & 40 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,50 +6,12 @@ To account for different stakeholder perspectives, we benefit from a diverse gro
Please see our project documentation in the [wiki](https://github.com/CERTCC/SSVC/wiki) that accompanies this repository
for more information on how you can contribute to the project.

## Where to contribute

This repository contains both a written document with the English-langauge spec, and some code for automating application of SSVC.
Contributions to these two parts of the project look different.
We are focusing on getting the English right first, so we know what code to write.
Right now we don't have any plans for translations, but if you have interest in that [let us know](https://github.com/CERTCC/SSVC/issues/123).

# Contributing to the document

The English text lives in the `docs` [subfolder](https://github.com/CERTCC/SSVC/tree/main/docs).
We welcome any issues from anyone in the community, so we can discuss them and improve SSVC.
If you have a suggestion, please [create an issue](https://github.com/CERTCC/SSVC/issues/new/choose).

In general, please create an issue before making a pull request to submit a change, except in the case of fixing a small
typo, etc.
Please check that your suggestion does not overlap with existing [issues](https://github.com/CERTCC/SSVC/issues)
(including [closed ones](https://github.com/CERTCC/SSVC/issues?q=is%3Aissue+is%3Aclosed+))

Please see the [SSVC project wiki]([wiki](https://github.com/CERTCC/SSVC/wiki) for how to keep any
suggestions or commits aligned with our style consistently.

# Contributing code

The tools for working with SSVC live in the `src` [subfolder](https://github.com/CERTCC/SSVC/tree/main/src).

We have limited tooling at the moment. The expectation is that these will mostly be flexible helper-type scripts and plug-ins.
Therefore, interoperability is important.
Where the code implements or directly references some aspect of the English document, please make that linkage explicit.
We use config files stored in `data` to prevent code in `src` from having fragile dependencies on the English doc.
We would like to minimize manual change management, but at the very least we need to document where changes in the
document need to result in changes to code.
Information likely to change based on changes to the English should go in config files to be stored in the
`data` [subfolder](https://github.com/CERTCC/SSVC/tree/main/data).
Code in the `src` folder should (as robustly as plausible) be reading that data in.

The process is similar to that for the doc, though the language is different. Please create issues before making pull requests.
Pull requests on code should be clear about what they've changed and what you've done. Thanks in advance!

# Licenses
## Licenses

- The license for all code in the repository is [here](https://github.com/CERTCC/SSVC/blob/main/LICENSE)
- The license for all English writing in the repository is [here](https://github.com/CERTCC/SSVC/blob/main/doc/version_1/900_license.md)

# Questions
## Questions

If you have any questions, an [issue](https://github.com/CERTCC/SSVC/issues) or
[discussion](https://github.com/CERTCC/SSVC/discussions) is the best way to get in touch with us.
Expand Down
57 changes: 57 additions & 0 deletions docs/_includes/helping_out.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# How Can I Engage with the SSVC Community?

We welcome your feedback and contributions to SSVC. Here are some ways you can get involved:

<div class="grid cards" markdown>

- :material-message-question: _Ask a question_

---

If you have a specific question for the SSVC team, please feel free to
[Ask a Question](https://github.com/CERTCC/SSVC/issues/new?template=question.md).

Questions of more general interest to the community of SSVC users might fit better in the
[Q&A](https://github.com/CERTCC/SSVC/discussions/categories/q-a) section of the
[Discussion](https://github.com/CERTCC/SSVC/discussions) area.

- :fontawesome-solid-bug: _Report a problem_

---

If you find a problem with the SSVC documentation, the methodology, or accompanying code, we
welcome your [Bug Reports](https://github.com/CERTCC/SSVC/issues/new?template=bug_report.md)

- :material-lightbulb-on: _Suggest an improvement_

---
Got an idea for how to make SSVC better? We'd love to hear it! Please submit your
[Feature Requests](https://github.com/CERTCC/SSVC/issues/new?template=feature_request.md)

- :fontawesome-regular-comments: _Join the conversation_

---

More in-depth conversations that might not be actionable as issues are found in the
[Discussions](https://github.com/CERTCC/SSVC/discussions) area.

- :material-binoculars: _See what we're working on_

---

We manage the SSVC development effort via Github [Issues](https://github.com/CERTCC/SSVC/issues) and
[Pull Requests](https://github.com/CERTCC/SSVC/pulls).
Drop by and see what we're working on, or leave a comment to let us know what you're interested in.

- :material-hub: _Get more involved_

---

Want more information about engaging as a collaborator? Check out the [SSVC Project Wiki](https://github.com/CERTCC/SSVC/wiki)

</div>


!!! tip "Footer Icons"

The icons in the footer of each page also provide links to engage with the SSVC community.
3 changes: 2 additions & 1 deletion docs/about/contact_us.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Contact Us

Software Engineering Institute
Expand All @@ -7,3 +6,5 @@ Software Engineering Institute
**Phone**: 412.268.5800 | 888.201.4479
**Web**: [www.sei.cmu.edu](http://www.sei.cmu.edu)
**Email**: [[email protected]](mailto:[email protected])

{% include-markdown "../_includes/helping_out.md" heading-offset=1 %}
2 changes: 2 additions & 0 deletions docs/about/contributing.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
{% include-markdown "../_includes/helping_out.md" %}

{% include-markdown "../../CONTRIBUTING.md" %}
16 changes: 9 additions & 7 deletions docs/about/index.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# About SSVC

SSVC version 2 presents a method for suppliers, deployers, and coordinators to use to prioritize their effort to mitigate vulnerabilities.
We have built on SSVC version 1 through public presentation and feedback, private consultation, and continued analyst testing.
The evaluation process we developed in version 1 remains an important part of continued improvement of SSVC, and will be used to continue refinements of SSVC version 2.
We invite participation and further refinement of the prioritization mechanism from the community as well, such as by [posting an issue](https://github.com/CERTCC/SSVC/issues).
SSVC presents a method for suppliers, deployers, and coordinators to use to prioritize their effort to mitigate vulnerabilities.
We have built on previous SSVC versions through public presentation and feedback, private consultation, and continued analyst testing.
The evaluation process we developed in version 1 remains an important part of continued improvement of SSVC, and will be used to continue refinements of SSVC going forward.
We invite [participation](contributing.md) and further refinement of the prioritization mechanism from the community as well, such as by [posting an issue](https://github.com/CERTCC/SSVC/issues).
We endeavored to be transparent about our process and provide justification for design decisions.

We invite questions, comments, and further community refinement in moving forward with a transparent and justified vulnerability prioritization methodology that is inclusive for the various stakeholders and industries that develop and use information and computer technology.
We invite questions, comments, and further community refinement in moving forward with a transparent and justified
vulnerability prioritization methodology that is inclusive for the various stakeholders and industries that develop
and use information and computer technology.


<div class="grid cards" markdown>

- :material-offer: [Community Engagement](contributing.md)
- :material-arrow-decision: [Decision Records](../adr/index.md)
- :material-handshake: [Acknowledgements](acknowledgements.md)
- :material-delta: [Change Log](changelog.md)
- :material-offer: [Contributing](contributing.md)
- :material-arrow-decision: [Decision Records](../adr/index.md)
- :material-copyright: [Copyright](copyright.md)
- :material-inbox-arrow-down: [Contact Us](contact_us.md)

Expand Down
5 changes: 4 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,7 @@ We have organized the SSVC documentation into four main sections:

[:octicons-arrow-right-24: Reference](reference/index.md)

</div>
</div>


{% include-markdown "_includes/helping_out.md" heading-offset=1 %}
18 changes: 13 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,13 @@ nav:
- Calculator: 'ssvc-calc/index.html'
- About:
- Intro: 'about/index.md'
- Change log: 'about/changelog.md'
- Contributing: 'about/contributing.md'
- Community Engagement: 'about/contributing.md'
# - FAQ: 'about/faq.md'
- Decision Records: 'adr/index.md'
- Acknowledgements: 'about/acknowledgements.md'
- Change log: 'about/changelog.md'
- Copyright: 'about/copyright.md'
- Contact: 'about/contact_us.md'
- Issue Tracker: 'https://github.com/CERTCC/SSVC/issues'
not_in_nav: |
_*.md
_*/**/*.md
Expand Down Expand Up @@ -152,9 +151,18 @@ markdown_extensions:
- tables
extra:
social:
- icon: material/message-question
link: https://github.com/CERTCC/SSVC/issues/new?template=question.md
name: Ask a Question
- icon: fontawesome/solid/bug
link: https://github.com/CERTCC/SSVC/issues
name: Report an Issue or Suggest a Change
link: https://github.com/CERTCC/SSVC/issues/new?template=bug_report.md
name: Report a Problem
- icon: material/lightbulb-on
link: https://github.com/CERTCC/SSVC/issues/new?template=feature_request.md
name: Request a Feature
- icon: fontawesome/regular/comments
link: https://github.com/CERTCC/SSVC/discussions
name: SSVC Community Discussions
- icon: fontawesome/brands/github
link: https://github.com/CERTCC/SSVC
name: CERTCC/SSVC on Github
Expand Down

0 comments on commit 06a943b

Please sign in to comment.