Skip to content

Commit

Permalink
changes in readme, added contributing guide draft
Browse files Browse the repository at this point in the history
  • Loading branch information
akyriako committed Jul 13, 2024
1 parent f07aeb2 commit caa2f24
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
1 change: 1 addition & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
- main
paths-ignore:
- '**/README.md'
- '**/CONTRIBUTING.md'

jobs:
build:
Expand Down
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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/)

8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
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.

0 comments on commit caa2f24

Please sign in to comment.