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

📖 Create the Frequently Asked Questions Document #2327

Merged
merged 5 commits into from
Oct 5, 2022
Merged

📖 Create the Frequently Asked Questions Document #2327

merged 5 commits into from
Oct 5, 2022

Conversation

joycebrum
Copy link
Contributor

What kind of change does this PR introduce?

docs update

What is the new behavior (if this is a feature change)?**

The README file should link to the FAQ document.

  • Tests for the changes have been added (for bug fixes/features)

Which issue(s) this PR fixes

Fixes #2326

Special notes for your reviewer

These are some question we've gather so far, the idea is that the SACI team would help to keep this faq.md up to date.

Does this PR introduce a user-facing change?

For user-facing changes, please add a concise, human-readable release note to
the release-note

(In particular, describe what changes users might need to make in their
application as a result of this pull request.)

NONE

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>
Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>
@joycebrum joycebrum temporarily deployed to integration-test October 4, 2022 17:50 Inactive
@joycebrum joycebrum temporarily deployed to integration-test October 4, 2022 18:05 Inactive
@github-actions
Copy link

github-actions bot commented Oct 4, 2022

Integration tests success for
[b94cc4d]
(https://github.com/ossf/scorecard/actions/runs/3184300461)

Copy link
Contributor

@olivekl olivekl left a comment

Choose a reason for hiding this comment

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

Thank you for this! I've made some comments, all minor changes for clarity or wordsmithing. Let's get this added and then we can further refine answers over time.

README.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
docs/faq.md Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Oct 4, 2022

Integration tests success for
[5b26b8a]
(https://github.com/ossf/scorecard/actions/runs/3184383544)

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>
@joycebrum joycebrum temporarily deployed to integration-test October 4, 2022 18:52 Inactive
@github-actions
Copy link

github-actions bot commented Oct 4, 2022

Integration tests success for
[5f723e0]
(https://github.com/ossf/scorecard/actions/runs/3184675863)

@naveensrinivasan naveensrinivasan enabled auto-merge (squash) October 4, 2022 20:25
@codecov
Copy link

codecov bot commented Oct 4, 2022

Codecov Report

Merging #2327 (3350786) into main (ae75d43) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2327   +/-   ##
=======================================
  Coverage   40.51%   40.51%           
=======================================
  Files         112      112           
  Lines        8818     8818           
=======================================
  Hits         3573     3573           
  Misses       4984     4984           
  Partials      261      261           

@joycebrum joycebrum temporarily deployed to integration-test October 5, 2022 18:05 Inactive
@github-actions
Copy link

github-actions bot commented Oct 5, 2022

Integration tests success for
[3350786]
(https://github.com/ossf/scorecard/actions/runs/3191643327)

@naveensrinivasan naveensrinivasan merged commit 4b99a3a into ossf:main Oct 5, 2022
N8BWert pushed a commit to N8BWert/scorecard that referenced this pull request Nov 28, 2022
* docs: create faq.md file

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>

* docs: update README to refer FAQ

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>

* docs: minor fixes in the faq text

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>
Signed-off-by: nathaniel.wert <nathaniel.wert@kudelskisecurity.com>
N8BWert pushed a commit to N8BWert/scorecard that referenced this pull request Nov 28, 2022
* docs: create faq.md file

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>

* docs: update README to refer FAQ

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>

* docs: minor fixes in the faq text

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>
Signed-off-by: nathaniel.wert <nathaniel.wert@kudelskisecurity.com>
raghavkaul pushed a commit to raghavkaul/scorecard that referenced this pull request Feb 9, 2023
* docs: create faq.md file

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>

* docs: update README to refer FAQ

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>

* docs: minor fixes in the faq text

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>

Signed-off-by: Joyce Brum <joycebrumu.u@gmail.com>
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.

Feature: create a FAQ for Scorecard
3 participants