diff --git a/README.md b/README.md index 0de3247..af6589f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # IAI Style Guide +It is way easier to collaborate on code and papers by having a strictly defined practical style guide. This repository defines guidelines for members and collaborators of the [Information Access & Interaction group](https://iai.group) at the University of Stavanger. * [Python style guide](python/) diff --git a/markdown/README.md b/markdown/README.md index 534a912..48fed23 100644 --- a/markdown/README.md +++ b/markdown/README.md @@ -5,6 +5,10 @@ * README files are to be named all-caps `README.md`. * Other files names are capitalized (i.e., first letter of a word in uppercase, and the rest of the letters in lowercase) and `_` -separated (e.g., `Writing_style.md`). +## Spacing + + * There should be an empty line before and after headers. + ## Markup * Top-level lists are marked by `*`, second, third, etc. levels below are marked by `-`. E.g., diff --git a/python/README.md b/python/README.md index 4c7af42..540bad9 100644 --- a/python/README.md +++ b/python/README.md @@ -1,5 +1,7 @@ # IAI Python Style Guide +Keep in mind that **сode is read more often than it is written**. + We follow the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html). This document highlights a number of peculiarities to pay special attention to, as well as complements the Google style guide on issues not specified there. ## Highlighted from the Google Python Style Guide