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

Introduce style guide #88

Merged
merged 28 commits into from Sep 11, 2020
Merged

Introduce style guide #88

merged 28 commits into from Sep 11, 2020

Conversation

corvus-ch
Copy link
Contributor

@corvus-ch corvus-ch commented Sep 7, 2020

This documents the style guide as it was discussed in #40.

Checklist

  • Keep pull requests small so they can be easily reviewed.
  • Update the documentation.
  • Link this PR to related issues.

@corvus-ch corvus-ch self-assigned this Sep 7, 2020
@corvus-ch corvus-ch marked this pull request as ready for review September 7, 2020 11:59
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@tobru tobru left a comment

Choose a reason for hiding this comment

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

As this also includes documentation about the Asciidoc style should there be some words about the usage of vale and which rules are enforced by it?

Other than that, I found some small things to fix, but overall LGTM.

docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
@corvus-ch
Copy link
Contributor Author

As this also includes documentation about the Asciidoc style should there be some words about the usage of vale and which rules are enforced by it?

Good point. Will do.

Copy link
Contributor

@tobru tobru left a comment

Choose a reason for hiding this comment

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

The typo needs to be fixed. Other than that: LGTM

docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@Kidswiss Kidswiss left a comment

Choose a reason for hiding this comment

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

Just a few minor things. The rest looks good and sensible.

docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
Copy link
Member

@simu simu left a comment

Choose a reason for hiding this comment

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

A bunch of typos, but LGTM overall now

docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/references/style-guide.adoc Outdated Show resolved Hide resolved
@corvus-ch corvus-ch merged commit 4e14a6a into master Sep 11, 2020
@corvus-ch corvus-ch deleted the style branch September 11, 2020 12:26
@corvus-ch corvus-ch mentioned this pull request Sep 14, 2020
1 task
simu added a commit to projectsyn/commodore that referenced this pull request Sep 18, 2020
We decided in projectsyn/documentation#88 that
we want to pad arrays in Jsonnet.

This commit adds the `--pad-arrays` argument to the default jsonnetfmt
arguments in the component template Makefile.
simu added a commit to projectsyn/commodore that referenced this pull request Sep 18, 2020
We decided in projectsyn/documentation#88 that
we want to pad arrays in Jsonnet.

This commit adds the `--pad-arrays` argument to the default jsonnetfmt
arguments in the component template Makefile.
@corvus-ch corvus-ch mentioned this pull request Sep 28, 2020
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.

None yet

6 participants