diff options
author | andy5995 <andy400-dev@yahoo.com> | 2022-01-22 23:41:29 -0600 |
---|---|---|
committer | Jussi Pakkanen <jpakkane@gmail.com> | 2022-01-23 15:27:59 +0200 |
commit | a00ede432f9c090d7e32331ee33d134f4bba478e (patch) | |
tree | a5c09a2a21137d98b3ec0524055c36d9c60813d9 | |
parent | 14d811f64734205326b4c661d0083c5221829a3f (diff) | |
download | meson-a00ede432f9c090d7e32331ee33d134f4bba478e.zip meson-a00ede432f9c090d7e32331ee33d134f4bba478e.tar.gz meson-a00ede432f9c090d7e32331ee33d134f4bba478e.tar.bz2 |
Contributing.md:specify max line length for docs
I thought it would good to specify a general rule here so people can set
their line wrapping appropriately.
[skip ci]
-rw-r--r-- | docs/markdown/Contributing.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/markdown/Contributing.md b/docs/markdown/Contributing.md index 3e3ff22..e0d22ca 100644 --- a/docs/markdown/Contributing.md +++ b/docs/markdown/Contributing.md @@ -445,10 +445,12 @@ To promote consistent naming policy, use: ## Documentation The `docs` directory contains the full documentation that will be used -to generate [the Meson web site](http://mesonbuild.com). Every change -in functionality must change the documentation pages. In most cases -this means updating the reference documentation page but bigger -changes might need changes in other documentation, too. +to generate [the Meson web site](http://mesonbuild.com). Line length +in most cases should not exceed 70 characters (lines containing links +or examples are usually exempt). Every change in functionality must +change the documentation pages. In most cases this means updating the +reference documentation page but bigger changes might need changes in +other documentation, too. All new functionality needs to have a mention in the release notes. These features should be written in standalone files in the |