search

memgraph / helm-charts

Helm charts for deploying Memgraph, an open-source in-memory graph database.
https://memgraph.github.io/helm-charts/
Apache License 2.0
13 stars 9 forks source link

[Bug]: Contributions - Please provide a pre-commit or something to enforce formatting #8

Closed jseiser closed 4 months ago

jseiser commented 1 year ago

Contact Details

justinseiser@gmail.com

What happened?

When contributing to this chart, it would be nice if you all provided some sort of pre-commit or something similar so all of our code was forced to be formatted the same way. Same with generating a readme, or providing some sort of linter_values.yaml that has to be ran etc.

Im much more familiar with Gitlab, than github, but being able to enforce these things locally, will def. make passing your Github CI easier for us when we contribute.

Example pre-commit

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.4.0
    hooks:
      # Git style
      - id: check-added-large-files
      - id: check-merge-conflict
      - id: check-vcs-permalinks
      - id: forbid-new-submodules
      - id: no-commit-to-branch

      # Common errors
      - id: end-of-file-fixer
      - id: trailing-whitespace
        args: [--markdown-linebreak-ext=md]
        exclude: CHANGELOG.md
      - id: check-merge-conflict
      - id: check-executables-have-shebangs

      # Cross platform
      - id: check-case-conflict
      - id: mixed-line-ending
        args: [--fix=lf]

      # Security
      - id: detect-private-key

  - repo: https://github.com/norwoodj/helm-docs
    rev: v1.11.0
    hooks:
      - id: helm-docs

Chart type

Standalone

Chart version

0.1.0

Environment

Local Machine

Relevant log output

No response

antejavor commented 1 year ago

Thanks for reporting this issue @jseiser, we were planning to add this, it will come in the following weeks.