dNation Kubernetes Monitoring Contributing Guidelines

Thank you for considering to contribute to dNation Kubernetes Monitoring project.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or by any other method with the owners of this repository before making a change.

Pull Request Checklist

Before sending your pull requests, make sure you followed this list.

• Read Contributing Guidelines
• Read Code of Conduct
• Read Commit Message Convention
• Read How To simplify your local development
• Set up the Developer Certificate of Origin (DCO)
• Include a License at the top of new files
• Update the Readme with details of changes to the interface
• In case the pull request would update the version number, please edit the version number in all appropriate files e.g. Chart.yaml. Read more about our chart versioning policy.
• Choose appropriate base branch for pull request. Read more about our release policy.
• You may merge the Pull Request once you have the sign-off of other developer, or if you don't have the permission to do that, you may request the reviewer to merge it for you

Developer Certificate of Origin (DCO)

The Developer Certificate of Origin (DCO) is a legally binding statement that asserts that you are the creator of your contribution, and that you wish to allow dNation Kubernetes Monitoring project to use your work.

Acknowledgement of this permission is done using a sign-off process in Git. The sign-off is a simple line at the end of the explanation for the patch. The text of the DCO is available on developercertificate.org.

If you are willing to agree to these terms, you just add a line to every git commit message:

Signed-off-by: Joe Smith <joe.smith@email.com>

If you set your user.name and user.email as part of your git configuration, you can sign your commit automatically with git commit -s.

Unfortunately, you have to use your real name (i.e., pseudonyms or anonymous contributions cannot be made). This is because the DCO is a legally binding document, granting the dNation Kubernetes Monitoring project to use your work.

License on the top of file

/*
  Copyright 2020 The dNation Kubernetes Monitoring Authors. All Rights Reserved.
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
      http://www.apache.org/licenses/LICENSE-2.0
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/

Release policy

• Release branch vMajor.Minor.x (e.g. v1.1.x) - all PRs with new functionality should target this branch
• PRs with hot-fixes target main branch

Chart versioning policy

Versioning scheme is SemVer.

• version: should increase when changes in chart are made
• appVersion: should increase when changes in jsonnet/ folder are made (when appVersion is increased, version has to be too)
• version and appVersion in release branch are set to same version as new release will be