From fdfe2a4e685dd9c02bfe219c81767464d7ba6a73 Mon Sep 17 00:00:00 2001 From: Lukas Neubert Date: Mon, 16 Nov 2020 16:49:40 +0100 Subject: [PATCH] check-md: check CONTRIBUTING.md too (#6847) --- .github/workflows/ci.yml | 2 ++ .github/workflows/docs_ci.yml | 4 +++- CONTRIBUTING.md | 3 ++- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 087727392f..dcfae7ff10 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,10 +5,12 @@ on: paths-ignore: - "doc/**" - "CHANGELOG.md" + - "CONTRIBUTING.md" pull_request: paths-ignore: - "doc/**" - "CHANGELOG.md" + - "CONTRIBUTING.md" jobs: code-formatting: diff --git a/.github/workflows/docs_ci.yml b/.github/workflows/docs_ci.yml index 555ece0179..f94d24cb52 100644 --- a/.github/workflows/docs_ci.yml +++ b/.github/workflows/docs_ci.yml @@ -6,11 +6,13 @@ on: - "cmd/tools/check-md.v" - "doc/**" - "CHANGELOG.md" + - "CONTRIBUTING.md" pull_request: paths: - "cmd/tools/check-md.v" - "doc/**" - "CHANGELOG.md" + - "CONTRIBUTING.md" jobs: docs-line-len-check: @@ -20,4 +22,4 @@ jobs: - name: Build V run: make - name: Check docs line length & code examples - run: ./v run cmd/tools/check-md.v doc/docs.md doc/upcoming.md CHANGELOG.md + run: ./v run cmd/tools/check-md.v doc/docs.md doc/upcoming.md CHANGELOG.md CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 528cd1aa5c..962cbc7ae3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,8 @@ download the C version of the compiler and rebuild it from scratch. The architecture of the compiler is very simple and has three distinct steps: -Parse/generate AST (`v.parser`) => Check types (`v.checker`) => Generate C/JavaScript/machine code (`v.gen`) +Parse/generate AST (`v.parser`) => Check types (`v.checker`) +=> Generate C/JavaScript/machine code (`v.gen`) The main files are: