Merge pull request #9 from lablabs/contributions

Documentation and pre-commit

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# How to contribute
+
+Feel free to:
+
+- [Create an issue](https://help.github.com/articles/creating-an-issue/)
+- [Make a pull request](https://services.github.com/on-demand/github-cli/open-pull-request-github) into the `main` branch
+
+Here is how you can help, a lot of steps are related to GitHub, not specifically my roles.
+
+## 1. Create an issue
+
+When you see some issue or have an idea for improvement, [create an issue](https://github.com/lablabs/ansible-nexus_config/issues).
+
+## 2. Fork the project
+
+Click on `fork` on the top-right corner and fork the repository.
+
+## 3. Install pre-commit
+
+1. Install [pre-commit](https://pre-commit.com/#install) software  
+2. Install [helm-docs](https://github.com/norwoodj/helm-docs#installation) pre-commit hook
+3. Run `pre-commit install` in the repository root directory
+
+## 4. Make the changes
+
+Do the changes in your own GitHub namespace.
+
+## 5. Test the changes
+
+Test your changes locally. Also please run `helm lint charts/node-local-dns`.
+
+## 6. Create a pull request
+
+Please create a pull request into the `master` branch. Here is [how to do it](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
+
+## 7. Semantic Commits
+
+Commits must follow conventional specs below:
+
+- `ci:` Changes to our CI configuration files and scripts (example scopes: GitHub Actions)
+- `docs:` Documentation only changes
+- `feat:` A new feature
+- `fix:` A bug fix
+- `refactor:` A code change that neither fixes a bug nor adds a feature
+- `style:` Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- `test:` Adding missing tests or correcting existing tests

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+# Description
+
+<!---
+Please include a summary of the change and which issue is fixed.
+--->
+
+## Type of change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+- [ ] Small minor change not affecting the Ansible Role code (Github Actions Workflow, Documentation etc.)
+
+## How Has This Been Tested?
+<!---
+Please describe the tests that you ran to verify your changes.
+Create a PR into `main` branch.
+--->

.github/workflows/release.yaml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - master
-      - feat/*
 
 jobs:
   release:

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+  - repo: https://github.com/norwoodj/helm-docs
+    rev: v1.11.3
+    hooks:
+      - id: helm-docs
+        args:
+          # Make the tool search for charts only under the `example-charts` directory
+          - --chart-search-root=charts/node-local-dns/
+
+          # The `./` makes it relative to the chart-search-root set above
+          - --template-files=./README.md.gotmpl

README.md

@@ -1,6 +1,20 @@
 # NodeLocal DNSCache Helm chart
 
-![Release Charts](https://github.com/lablabs/k8s-nodelocaldns-helm/workflows/Release%20Charts/badge.svg?branch=master) [![Releases downloads](https://img.shields.io/github/downloads/lablabs/k8s-nodelocaldns-helm/total.svg)](https://github.com/lablabs/k8s-nodelocaldns-helm/releases)
+![Release Charts](https://github.com/lablabs/k8s-nodelocaldns-helm/workflows/Release%20Charts/badge.svg?branch=master) 
+[![Releases downloads](https://img.shields.io/github/downloads/lablabs/k8s-nodelocaldns-helm/total.svg)](https://github.com/lablabs/k8s-nodelocaldns-helm/releases)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/lablabs/k8s-nodelocaldns-helm/blob/master/charts/node-local-dns/LICENSE)
+
+[<img src="https://lablabs.io/static/ll-logo.png" width=350px>](https://lablabs.io/)
+
+We help companies build, run, deploy and scale software and infrastructure by embracing the right technologies and principles. Check out our website at <https://lablabs.io/>
+
+---
+
+## Description
+
+A Helm chart to deploy Node Local DNS Cache.
+
+More details about the chart and it's configuration can be found [here](charts/node-local-dns/README.md)
 
 ## Helm Chart Repository
 

charts/node-local-dns/Chart.yaml

@@ -1,10 +1,11 @@
 ---
 apiVersion: v2
 name: node-local-dns
-version: 1.4.0-rc.4
+version: 1.5.0
 appVersion: 1.22.24
 home: https://github.com/lablabs/k8s-nodelocaldns-helm
 description: NodeLocal DNS Cache helm chart
+icon: https://raw.githubusercontent.com/kubernetes/kubernetes/master/logo/logo.svg
 keywords:
   - node
   - dns
@@ -20,4 +21,4 @@ type: application
 annotations:
   artifacthub.io/changes: |
     - Initial helm chart changelog
-    - Update node-cache version, add support for better granular logging.
+    - Update node-cache version, add support for better granular logging

charts/node-local-dns/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright [2021] [Labyrinth Labs]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.