From 775bb1ec5eb1862526e9a4ba7fcffc8fc5ec9ca2 Mon Sep 17 00:00:00 2001 From: Sebastian Wendel Date: Tue, 22 Nov 2022 23:40:49 +0100 Subject: [PATCH] fixed naming issues --- .editorconfig | 4 ++++ CONTRIBUTING.md | 8 ++++---- Chart.yaml | 2 +- Makefile | 2 +- README.md | 4 +++- 5 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.editorconfig b/.editorconfig index 4931a0b..58f6fd8 100644 --- a/.editorconfig +++ b/.editorconfig @@ -8,6 +8,10 @@ indent_style = space insert_final_newline = true max_line_length = 120 +[*.{nix}] +indent_size = 2 +indent_style = space + [*.{yml,yaml}] indent_size = 2 indent_style = space diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7d72da3..919ad13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,13 +17,13 @@ First of all, thank you for contributing to FCOS! The goal of this document is t ## 🚧 How to Contribute -1. Make sure that the contribution you want to make is explained or detailed in a Gitlab issue! Find an [existing issue](https://gitlab.fabcity.hamburg/software/fabcity-os-core-chart/-/issues) or [open a new one](https://gitlab.fabcity.hamburg/software/fabcity-os-core-chart/-/issues/new). +1. Make sure that the contribution you want to make is explained or detailed in a Gitlab issue! Find an [existing issue](https://gitlab.fabcity.hamburg/software/fcoscore-chart/-/issues) or [open a new one](https://gitlab.fabcity.hamburg/software/fcoscore-chart/-/issues/new). 2. Once done, [fork the FCOS Core Chart repository](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) in your Gitlab account. Ask a maintainer if you want your issue to be checked before making a PR. 3. [Create a new Git branch](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-new-branch). 4. Review the [Development Workflow](#development-workflow) section that describes the steps to maintain the repository. 5. Make the changes on your branch. -6. [Submit the branch as a PR](https://docs.gitlab.com/ee/user/project/merge_requests/index.html) pointing to the `main` branch of the main fabcity-os-core-chart repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.
- We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://gitlab.fabcity.hamburg/software/fabcity-os-core-chart/releases/). +6. [Submit the branch as a PR](https://docs.gitlab.com/ee/user/project/merge_requests/index.html) pointing to the `main` branch of the main fcoscore-chart repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.
+ We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://gitlab.fabcity.hamburg/software/fcoscore-chart/releases/). ## 🎮 Setup a development environment @@ -41,7 +41,7 @@ In order to use the different tools on this repository, you will first need to: ## 👩‍💻 Development Workflow -1. 🔀 [Fork the Project](https://gitlab.fabcity.hamburg/software/fabcity-os-core-chart/-/forks/new) +1. 🔀 [Fork the Project](https://gitlab.fabcity.hamburg/software/fcoscore-chart/-/forks/new) 2. Check out `make help` 3. Create your feature branch `git checkout -b feature/branch` 4. Start the development Cluster `make up` diff --git a/Chart.yaml b/Chart.yaml index ae139e3..eaf1d49 100644 --- a/Chart.yaml +++ b/Chart.yaml @@ -4,7 +4,7 @@ description: Fab City OS Core Kubernetes Helm Chart version: 0.1.0 type: application appVersion: latest -home: https://gitlab.fabcity.hamburg/software/fabcity-os-core-chart +home: https://gitlab.fabcity.hamburg/software/fcoscore-chart icon: https://www.fabcity.hamburg/wp-content/uploads/2021/04/cropped-Fab_City_Hamburg@4x-192x192.png sources: - https://github.com/dyne/zenflows diff --git a/Makefile b/Makefile index 334a079..a36e7f4 100644 --- a/Makefile +++ b/Makefile @@ -107,7 +107,7 @@ package: ## Package the helm chart. @helm package . --destination charts push: ## Publish the helm chart. - @helm cm-push charts/fcoscore-*.tgz fabcity-os-core-chart + @helm cm-push charts/fcoscore-*.tgz fcoscore-chart %: @true diff --git a/README.md b/README.md index 11accff..21534b2 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@

- License + License Matrix

@@ -53,6 +53,8 @@ Helm CLI is a Command Line Interface which will automate chart management and in #### From the source files ```sh +git clone https://gitlab.fabcity.hamburg/software/fcoscore-chart.git +cd fcoscore-chart helm install fcoscore . ```