Skip to content

Commit

Permalink
user-guide: update contributing guides with bullet styles, and
Browse files Browse the repository at this point in the history
other small improvements.

Mainly per #491 (comment)
  • Loading branch information
jorgeorpinel committed Jul 24, 2019
1 parent bf396a3 commit 1bf9880
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
19 changes: 13 additions & 6 deletions static/docs/user-guide/contributing-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ setting up.

- Visit `http://localhost:3000/` and navigate to the docs in question.

## Code style guidelines
## Doc style guidelines (for Markdown)

- No trailing whitespaces are allowed.

Expand All @@ -97,13 +97,20 @@ setting up.
configured. You may also run `npx prettier --write <file path(s)>` manually
before committing changes.

- **Markdown**: Using `dvc <command>` in the documentation will create a link to
that command automatically. No need to use `[]()` explicitly to create them.
- Using `dvc <command>` in the documentation will create a link to that command
automatically. No need to use `[]()` explicitly to create them.

- **Markdown**: Syntax highlighting in fenced code blocks should use the `usage`
and `dvc` custom languages. `usage` is employed to show `dvc help` commands
- Bullet lists shouldn't be too long, nor each bullet's text (3 sentence
paragraphs max.) The bullets can begin in lower case and have no ending
punctuation if they're not full sentences (otherwise end with period `.`). The
bullets can be separated by an empty line if they contain short paragraphs.

- Syntax highlighting in fenced code blocks should use the `usage` `dvc`, and
`yaml` custom languages. `usage` is employed to show `dvc help` commands
output in each command reference doc. `dvc` can be used to show
[DVC-file](/doc/user-guide/dvc-file-format) contents, or examples of terminal
commands and their output.

> Check out any of the command reference `.md` source code to get a better idea.
> Check out any of the command reference `.md` source code to get a better idea,
> for example
> [this very doc](https://github.com/iterative/dvc.org/blob/master/static/docs/user-guide/contributing-documentation.md).
4 changes: 2 additions & 2 deletions static/docs/user-guide/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ $ ./scripts/ci/remove_hadoop.sh

</details>

## Code style guidelines
## Code style guidelines (for Python)

We are using [PEP8](https://www.python.org/dev/peps/pep-0008/?) and checking
that our code is formatted with [black](https://github.com/ambv/black).
Expand All @@ -274,7 +274,7 @@ For [docstrings](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring),
we try to adhere by the
[Google Python Style Guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings).

## Commit style guidelines
## Commit message format guidelines

Format:

Expand Down

0 comments on commit 1bf9880

Please sign in to comment.