Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
- Add information about cheat sheet, GitHub
actions.
- Rearrange content about pre-commit hooks.
  • Loading branch information
keirthana committed Jul 19, 2024
1 parent 0a8b285 commit 54f0555
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,20 +44,30 @@ To accommodate different kinds of audience, try to:

We (mostly) adhere to the [Ubuntu style guide](https://docs.ubuntu.com/styleguide/en). Any deviations from the Ubuntu style guide are documented in the [Anbox Cloud documentation style guide](./contribute/anbox-style-guide.md).

To help with syntax, there is a [cheat sheet](./contribute/doc-cheat-sheet.md) that lists the syntax for commonly used Markdown and MyST markup. For more detailed guidance, see the [MyST style guide](https://canonical-documentation-with-sphinx-and-readthedocscom.readthedocs-hosted.com/style-guide-myst/).

### Quality checks
* The following pre-commit checks are run automatically before every commit:
- Inclusive language checks (`woke`)
- Spellcheck (`spellcheck`)

#### Running pre-commit checks
**GitHub Actions**

The following GitHub actions run automatically on every pull request:
- Inclusive language check
- Spellcheck
- Accessibility check
- Link check

To be able to run these pre-commit checks:
**Pre-commit hooks**

To be able to run pre-commit checks, the following prerequisites should be fulfilled:

* Install the `pre-commit` package from the Ubuntu repositories.
* Install the `aspell` and `aspell-en` packages from the Ubuntu repositories. This is required by the spellchecker.
* Navigate to the top-level directory of this repository and run `pre-commit install --install-hooks`.

#### Overriding pre-commit checks
When the prerequisites are met, the following pre-commit checks are run automatically before every commit. They help in resolving basic issues before committing your changes.

- Inclusive language checks (`woke`)
- Spellcheck (`spellcheck`)

Enabling pre-commit checks are optional as these checks are executed on pull requests automatically. If you do not want to run these checks before commits or to skip a particular check, use the following tips:

Expand Down

0 comments on commit 54f0555

Please sign in to comment.