[devdocsgjs/main: 792/1867] Update contributing guidelines on updating docs
- From: Andy Holmes <andyholmes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [devdocsgjs/main: 792/1867] Update contributing guidelines on updating docs
- Date: Fri, 19 Nov 2021 23:47:29 +0000 (UTC)
commit c5136b1af67b3e1f01869c3b7ba8b5ca5ec41462
Author: Jasper van Merle <jaspervmerle gmail com>
Date: Tue Aug 13 11:57:56 2019 +0200
Update contributing guidelines on updating docs
.github/CONTRIBUTING.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
---
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 99fd8584..0f84b7c0 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -58,9 +58,9 @@ In addition to the [guidelines for contributing code](#contributing-code-and-fea
## Updating existing documentations
-Please don't submit a pull request updating the version number of a documentation, unless a change is
required in the scraper and you've verified that it works.
+Please don't submit a pull request updating only version number and/or the attribution of a documentation.
Do feel free to create a pull request if a bigger change is required in the scraper and you've verified that
it works. If you do make a pull request and you happen to update `options[:attribution]`, make sure to also
update the documentation's entry in the array in
[`assets/javascripts/templates/pages/about_tmpl.coffee`](../assets/javascripts/templates/pages/about_tmpl.coffee)
with correct license information.
-To ask that an existing documentation be updated, first check the last two [documentation versions
reports](https://github.com/freeCodeCamp/devdocs/issues?utf8=%E2%9C%93&q=Documentation+versions+report+is%3Aissue+author%3Adevdocs-bot+sort%3Acreated-desc).
Only create an issue if the documentation has been wrongly marked as up-to-date.
+To ask that an existing documentation be updated, first check the last [documentation versions
reports](https://github.com/freeCodeCamp/devdocs/issues?utf8=%E2%9C%93&q=Documentation+versions+report+is%3Aissue+author%3Adevdocs-bot+sort%3Acreated-desc).
Only create an issue if the documentation has been wrongly marked as up-to-date.
## Coding conventions
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]