k8c.io/api/v3@v3.0.0-20230904060738-b0a93889c0b6/CONTRIBUTING.md (about)

     1  # How to Contribute
     2  
     3  Loodse projects are [Apache 2.0 licensed](LICENSE) and accept contributions via
     4  GitHub pull requests. This document outlines some of the conventions on
     5  development workflow, commit message formatting, contact points and other
     6  resources to make it easier to get your contribution accepted.
     7  
     8  ## Certificate of Origin
     9  
    10  By contributing to this project you agree to the Developer Certificate of
    11  Origin (DCO). This document was created by the Linux Kernel community and is a
    12  simple statement that you, as a contributor, have the legal right to make the
    13  contribution. See the [DCO](DCO) file for details.
    14  
    15  Any copyright notices in this repo should specify the authors as "the Loodse XXX project contributors".
    16  
    17  To sign your work, just add a line like this at the end of your commit message:
    18  
    19  ```
    20  Signed-off-by: Joe Example <joe@example.com>
    21  ```
    22  
    23  This can easily be done with the `--signoff` option to `git commit`.
    24  
    25  Note that we're requiring all commits in a PR to be signed-off. If you already created a PR, you can sign-off all existing commits by rebasing with the `--signoff` flag.
    26  
    27  ```
    28  git rebase --signoff origin/master
    29  ```
    30  
    31  By doing this you state that you can certify the following (from https://developercertificate.org/):
    32  ```
    33  Developer Certificate of Origin
    34  Version 1.1
    35  
    36  Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
    37  1 Letterman Drive
    38  Suite D4700
    39  San Francisco, CA, 94129
    40  
    41  Everyone is permitted to copy and distribute verbatim copies of this
    42  license document, but changing it is not allowed.
    43  
    44  
    45  Developer's Certificate of Origin 1.1
    46  
    47  By making a contribution to this project, I certify that:
    48  
    49  (a) The contribution was created in whole or in part by me and I
    50      have the right to submit it under the open source license
    51      indicated in the file; or
    52  
    53  (b) The contribution is based upon previous work that, to the best
    54      of my knowledge, is covered under an appropriate open source
    55      license and I have the right under that license to submit that
    56      work with modifications, whether created in whole or in part
    57      by me, under the same open source license (unless I am
    58      permitted to submit under a different license), as indicated
    59      in the file; or
    60  
    61  (c) The contribution was provided directly to me by some other
    62      person who certified (a), (b) or (c) and I have not modified
    63      it.
    64  
    65  (d) I understand and agree that this project and the contribution
    66      are public and that a record of the contribution (including all
    67      personal information I submit with it, including my sign-off) is
    68      maintained indefinitely and may be redistributed consistent with
    69      this project or the open source license(s) involved.
    70  ```
    71  
    72  ## Email and Chat
    73  
    74  The XXX project currently uses the general Loodse email list and Slack channel:
    75  - Email: [loodse-dev](https://groups.google.com/forum/#!forum/loodse-dev)
    76  - Slack: #[Slack](http://slack.kubermatic.io/) on Slack
    77  
    78  Please avoid emailing maintainers found in the MAINTAINERS file directly. They
    79  are very busy and read the mailing lists.
    80  
    81  ## Reporting a security vulnerability
    82  
    83  Due to their public nature, GitHub and mailing lists are not appropriate places for reporting vulnerabilities. If you suspect you have found a security vulnerability, please do not file a GitHub issue, but instead email security@loodse.com with the full details, including steps to reproduce the issue.
    84  
    85  ## Getting Started
    86  
    87  - Fork the repository on GitHub
    88  - Read the [README](README.md) for build and test instructions
    89  - Play with the project, submit bugs, submit patches!
    90  
    91  ### Contribution Flow
    92  
    93  This is a rough outline of what a contributor's workflow looks like:
    94  
    95  - Create a topic branch from where you want to base your work (usually master).
    96  - Make commits of logical units.
    97  - Make sure your commit messages are in the proper format (see below).
    98  - Push your changes to a topic branch in your fork of the repository.
    99  - Make sure the tests pass, and add any new tests as appropriate.
   100  - Submit a pull request to the original repository.
   101  
   102  Thanks for your contributions!