github.com/opencontainers/runc@v1.2.0-rc.1.0.20240520010911-492dc558cdd6/CONTRIBUTING.md (about)

     1  ## Contribution Guidelines
     2  
     3  ### Security issues
     4  
     5  If you are reporting a security issue, do not create an issue or file a pull
     6  request on GitHub. Instead, disclose the issue responsibly by sending an email
     7  to security@opencontainers.org (which is inhabited only by the maintainers of
     8  the various OCI projects).
     9  
    10  ### Pull requests are always welcome
    11  
    12  We are always thrilled to receive pull requests, and do our best to
    13  process them as fast as possible. Not sure if that typo is worth a pull
    14  request? Do it! We will appreciate it.
    15  
    16  If your pull request is not accepted on the first try, don't be
    17  discouraged! If there's a problem with the implementation, hopefully you
    18  received feedback on what to improve.
    19  
    20  We're trying very hard to keep runc lean and focused. We don't want it
    21  to do everything for everybody. This means that we might decide against
    22  incorporating a new feature. However, there might be a way to implement
    23  that feature *on top of* runc.
    24  
    25  
    26  ### Conventions
    27  
    28  Fork the repo and make changes on your fork in a feature branch:
    29  
    30  - If it's a bugfix branch, name it XXX-something where XXX is the number of the
    31    issue
    32  - If it's a feature branch, create an enhancement issue to announce your
    33    intentions, and name it XXX-something where XXX is the number of the issue.
    34  
    35  Submit unit tests for your changes.  Go has a great test framework built in; use
    36  it! Take a look at existing tests for inspiration. Run the full test suite on
    37  your branch before submitting a pull request.
    38  
    39  Update the documentation when creating or modifying features. Test
    40  your documentation changes for clarity, concision, and correctness, as
    41  well as a clean documentation build. See ``docs/README.md`` for more
    42  information on building the docs and how docs get released.
    43  
    44  Write clean code. Universally formatted code promotes ease of writing, reading,
    45  and maintenance. Always run `gofmt -s -w file.go` on each changed file before
    46  committing your changes. Most editors have plugins that do this automatically.
    47  
    48  Pull requests descriptions should be as clear as possible and include a
    49  reference to all the issues that they address.
    50  
    51  Pull requests must not contain commits from other users or branches.
    52  
    53  Commit messages must start with a capitalized and short summary (max. 50
    54  chars) written in the imperative, followed by an optional, more detailed
    55  explanatory text which is separated from the summary by an empty line.
    56  
    57  Code review comments may be added to your pull request. Discuss, then make the
    58  suggested modifications and push additional commits to your feature branch. Be
    59  sure to post a comment after pushing. The new commits will show up in the pull
    60  request automatically, but the reviewers will not be notified unless you
    61  comment.
    62  
    63  Before the pull request is merged, make sure that you squash your commits into
    64  logical units of work using `git rebase -i` and `git push -f`. After every
    65  commit the test suite should be passing. Include documentation changes in the
    66  same commit so that a revert would remove all traces of the feature or fix.
    67  
    68  Commits that fix or close an issue should include a reference like `Closes #XXX`
    69  or `Fixes #XXX`, which will automatically close the issue when merged.
    70  
    71  ### Sign your work
    72  
    73  The sign-off is a simple line at the end of the explanation for the
    74  patch, which certifies that you wrote it or otherwise have the right to
    75  pass it on as an open-source patch.  The rules are pretty simple: if you
    76  can certify the below (from
    77  [developercertificate.org](http://developercertificate.org/)):
    78  
    79  ```
    80  Developer Certificate of Origin
    81  Version 1.1
    82  
    83  Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
    84  660 York Street, Suite 102,
    85  San Francisco, CA 94110 USA
    86  
    87  Everyone is permitted to copy and distribute verbatim copies of this
    88  license document, but changing it is not allowed.
    89  
    90  
    91  Developer's Certificate of Origin 1.1
    92  
    93  By making a contribution to this project, I certify that:
    94  
    95  (a) The contribution was created in whole or in part by me and I
    96      have the right to submit it under the open source license
    97      indicated in the file; or
    98  
    99  (b) The contribution is based upon previous work that, to the best
   100      of my knowledge, is covered under an appropriate open source
   101      license and I have the right under that license to submit that
   102      work with modifications, whether created in whole or in part
   103      by me, under the same open source license (unless I am
   104      permitted to submit under a different license), as indicated
   105      in the file; or
   106  
   107  (c) The contribution was provided directly to me by some other
   108      person who certified (a), (b) or (c) and I have not modified
   109      it.
   110  
   111  (d) I understand and agree that this project and the contribution
   112      are public and that a record of the contribution (including all
   113      personal information I submit with it, including my sign-off) is
   114      maintained indefinitely and may be redistributed consistent with
   115      this project or the open source license(s) involved.
   116  ```
   117  
   118  then you just add a line to every git commit message:
   119  
   120      Signed-off-by: Joe Smith <joe@gmail.com>
   121  
   122  using your real name (sorry, no pseudonyms or anonymous contributions.)
   123  
   124  You can add the sign off when creating the git commit via `git commit -s`.