Skip to content

[Rule]:Punctuation and display #33

Description

@JC-DSIT

Is this

  • a suggestion for a new rule
  • an update to an existing rule
  • a suggestion to remove a rule

Why is this change important

The general content should:

  • have a capital letter at the start of every sentence (error)
  • have a full stop (or equivalent) at the end of every sentence (error)
  • have no semi colons, question marks or exclamation marks (warning - could be edge cases)
  • have no Oxford Comma's (suggestion)
  • no negative contractions (error)
  • no bold, italics or underlining
  • not have paragraphs of more then 5 sentences (suggestion)
  • Check all numbers are written as numerals (except ‘one’)

Examples of new behaviour as a result of the change

For example:

Scenario: Someone has created a page with a lot of new content, some of the words are over complicated
Given a page exists
And the page contains words from the words to avoid list
When the linter runs against the page with the "words to avoid" rule
Then the linter should fail

Add as many scenarios as you can think of to define the full behaviour of the rule. You can see existing examples in features/style_guide/*.feature

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions