Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 3.68 KB

CONTRIBUTING.adoc

File metadata and controls

72 lines (49 loc) · 3.68 KB
Raw

Contributing to Open Liberty documentation

If you find something incorrect or incomplete in our docs, let us know. For new topics, large updates to existing docs, or general suggestions and ideas, create an issue in the docs repository and assign it to David Mueller (dmuelle), Charlotte Holt (Charlotte-Holt), or one of the doc members.

If you want to make minor updates to existing docs, for example, fixing a broken link, complete the following steps:

  1. Clone the docs repo and create your feature branch off the default vNext branch. Do all your editing in this branch.

  2. Make the necessary edits to the doc or docs. If possible, check that the content looks right by using the preview function in your editor.

  3. Push the file to GitHub, then create a PR into the draft branch. Request a review of the PR from David Mueller (dmuelle), Charlotte Holt (Charlotte-Holt), or one of the doc members.

  4. The individual assigned to your PR will review the updates and work with you to merge them into the draft branch and build them to the Open Liberty draft website for further review.

  5. After the updates are validated, one of doc members will follow the steps to publish your updates.

If you contribute to the Open Liberty docs by opening a pull request, sign your work. The sign-off is a line at the end of the commit message that certifies that you wrote it or otherwise have the right to pass it on as an open source patch. The process is simple: if you can certify the following information (from developercertificate.org):

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

then add a line to the end of the Git commit message:

Signed-off-by: Jane Williams <[email protected]>

Use your real name when you sign. We can’t accept pseudonyms or anonymous contributions.

Many Git UI tools have support for adding the Signed-off-by line to the end of your commit message. This line can be automatically added by the git commit command by using the -s option.

Thanks to Bndtools for the wording on this sign-off process.