From caa2f248d0ffdcc602a687704f0564f29de89e8e Mon Sep 17 00:00:00 2001 From: Kyriakos Akriotis Date: Sat, 13 Jul 2024 10:02:47 +0200 Subject: [PATCH] changes in readme, added contributing guide draft --- .github/workflows/release.yaml | 1 + CONTRIBUTING.md | 9 +++++++++ README.md | 8 ++++++-- 3 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 2921e4480..0545e08de 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -4,6 +4,7 @@ on: - main paths-ignore: - '**/README.md' + - '**/CONTRIBUTING.md' jobs: build: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..bddce5a8e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +# Syntactic and Stylistic Guidelines + +## Syntax + +All text content should adhere to the guidelines provided by official [Markdown Guide](https://www.markdownguide.org/): + +* [Basic Syntax](https://www.markdownguide.org/basic-syntax/) +* [Extended Syntax](https://www.markdownguide.org/extended-syntax/) + diff --git a/README.md b/README.md index 8b819c1b4..527ab3910 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ This command starts a local development server and opens up a browser window. Ch npm run build ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service by the following command: +This command generates static content into the **build** directory and can be served using any static contents hosting service by the following command: ``` npm run serve @@ -77,4 +77,8 @@ The repository is already employed with a GitHub Release Workflow that will do t ArgoCD (deployed on the same CCE Cluster) will pick up the changes, within its `timeout.reconciliation` value (default is *180s*), and provision the changes without any human intervention. -The whole process is fully autonomous, and after the approval of every PR requires zero human intervention. \ No newline at end of file +The whole process is fully autonomous, and after the approval of every PR requires zero human intervention. + +## Contributing + +If you are contributing as content creator follow the [Syntactic and Stylistic Guidelines](/CONTRIBUTING.md) of the project. \ No newline at end of file