link to CONTRIBUTING.md from README.md

tegonal · Aug 18, 2023 · 7333819 · 7333819
1 parent aa1187e
commit 7333819
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -104,7 +104,7 @@ Finally, when you think your PR (short for pull request) is ready, then please:
 ## Coding Conventions
 So far we do not try to enforce too much. We will review your pull requests and comment if necessary.
 However, here a few hints in order that your pull request is merged quickly.
-1. Make sure the shellcheck does not generate warnings.
+1. Make sure shellcheck does not generate warnings.
 2. Try to write code in a similar style as the existing 
    (We suggest you copy something existing and modify it).
 3. Write readable code and express comments with code rather than comments.

diff --git a/README.md b/README.md
@@ -1455,6 +1455,10 @@ You are more than welcome to contribute as well:
   the [help wanted issues](https://github.com/tegonal/scripts/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
   if you would like to code.
 
+Please have a look at
+[CONTRIBUTING.md](https://github.com/tegonal/scripts/tree/main/.github/CONTRIBUTING.md)
+for further suggestions and guidelines.
+
 # License
 
 The provided scripts are licensed under [Apache 2.0](http://opensource.org/licenses/Apache2.0).