Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 2.17 KB
Raw

Introduction

The team behind the Naksha gratefully accepts contributions via pull requests filed against the GitHub project.

Signing each Commit

As part of filing a pull request we ask you to sign off the Developer Certificate of Origin (DCO) in each commit. Any Pull Request with commits that are not signed off will be reject by the DCO check.

A DCO is lightweight way for a contributor to confirm that you wrote or otherwise have the right to submit code or documentation to a project. Simply add Signed-off-by as shown in the example below to indicate that you agree with the DCO.

An example signed commit message:

    README.md: Fix minor spelling mistake

    Signed-off-by: John Doe <[email protected]>

Git has the -s flag that can sign a commit for you, see example below:

$ git commit -s -m 'README.md: Fix minor spelling mistake'

Branching strategy

Depending on whether your contribution is towards Naksha v1 or v2+, refer respective Branching/Versioning strategy:

Contributors are expected to make changes into their own feature_* branches, created out of respective main branch.

Local execution

From Local machine:

  • Validate service builds and starts - as per Getting Started section.
  • Validate your changes and normal functioning of service as per Usage instructions.

Before making a pull-request

Eventually, before making a pull request, ensure following:

  1. If any new secret parameter is introduced, then mention in pull-request as an indication for the repo-owner to add the secret in respective cloud environments.
  2. If any new config (not a secret) parameter is introduced in default-config.json, ensure the same is added into docker cloud-config.json as well.