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

[Pre537] Change github_advisory_sync.rb script to conform to project style guidelines #650

Open
jasnow opened this issue Jun 24, 2023 · 1 comment

Comments

@jasnow
Copy link
Contributor

jasnow commented Jun 24, 2023

Change github_advisory_sync.rb script to conform to project style guidelines.

Such as:
a. Fix indentation for related:/url:, patched_versions: and unafffected_versions fields.

  * "patched_version:" field needs to be moved over 4 spaces from left margin.
  * "related"/"url:" lines need to be moved over 2 spaces more (for total of 4 spaces from left margin).

b. Use of double quotes over single quotes

  • Exception: Can use single quotes when the text contains a period (".") or colon (":").

c. Fix description: multi-line format syntax.
d. Remove extra "url:" from related:/url: values.
e. Line wrap description: field to 80 columns.

  • Expect more to come
@postmodern
Copy link
Member

Ruby's YAML library will prefer double-quotes to single-quotes. Appears that single-quotes are only used when the String contains a : character. I think it's acceptable to allow single-quotes in that edge-case.

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

No branches or pull requests

2 participants