# CONTRIBUTING

Contributions are very welcome. When contributing code, please follow these

simple guidelines.

* Make sure you run `rustfmt` on your code. Also ensure all trailing whitespace is trimmed.

* Run the tests with `cargo test --all`.

* Before adding any code dependencies, check with the maintainers if this is okay.

* Write properly formatted comments: they should be English sentences, eg:

        // Return the current UNIX time.

* Read the DCO and make sure all commits are signed off, using `git commit -s`.

* Follow the guidelines when proposing code changes (see below).

* Write properly formatted git commits (see below).

Proposing changes

-----------------

When proposing changes via a pull-request or patch:

* Isolate changes in separate commits to make the review process easier.

* Don't make unrelated changes, unless it happens to be an obvious improvement to

  code you are touching anyway ("boyscout rule").

* Rebase on `master` when needed.

* Keep your changesets small, specific and uncontroversial, so that they can be

  merged more quickly.

* If the change is substantial or requires re-architecting certain parts of the

  codebase, write a proposal in English first, and get consensus on that before

  proposing the code changes.

Writing Git commit messages

---------------------------

A properly formed git commit subject line should always be able to complete the

following sentence:

     If applied, this commit will _____

In addition, it should be capitalized and *must not* include a period.

For example, the following message is well formed:

     Add support for .gif files

While these ones are **not**: `Adding support for .gif files`,

`Added support for .gif files`.

When it comes to formatting, here's a model git commit message[1]:

     Capitalized, short (50 chars or less) summary

     More detailed explanatory text, if necessary.  Wrap it to about 72

     characters or so.  In some contexts, the first line is treated as the

     subject of an email and the rest of the text as the body.  The blank

     line separating the summary from the body is critical (unless you omit

     the body entirely); tools like rebase can get confused if you run the

     two together.

     Write your commit message in the imperative: "Fix bug" and not "Fixed bug"

     or "Fixes bug."  This convention matches up with commit messages generated

     by commands like git merge and git revert.

     Further paragraphs come after blank lines.

     - Bullet points are okay, too.

     - Typically a hyphen or asterisk is used for the bullet, followed by a

       single space, with blank lines in between, but conventions vary here.

     - Use a hanging indent.

---

[1]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

Developer's Certificate of Origin 1.1

Copyright © 2004, 2006 The Linux Foundation and its contributors.

---

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.

                              Apache License

                        Version 2.0, January 2004

                     http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,

   and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by

   the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all

   other entities that control, are controlled by, or are under common

   control with that entity. For the purposes of this definition,

   "control" means (i) the power, direct or indirect, to cause the

   direction or management of such entity, whether by contract or

   otherwise, or (ii) ownership of fifty percent (50%) or more of the

   outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity

   exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,

   including but not limited to software source code, documentation

   source, and configuration files.

   "Object" form shall mean any form resulting from mechanical

   transformation or translation of a Source form, including but

   not limited to compiled object code, generated documentation,

   and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or

   Object form, made available under the License, as indicated by a

   copyright notice that is included in or attached to the work

   (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object

   form, that is based on (or derived from) the Work and for which the

   editorial revisions, annotations, elaborations, or other modifications

   represent, as a whole, an original work of authorship. For the purposes

   of this License, Derivative Works shall not include works that remain

   separable from, or merely link (or bind by name) to the interfaces of,

   the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including

   the original version of the Work and any modifications or additions

   to that Work or Derivative Works thereof, that is intentionally

   submitted to Licensor for inclusion in the Work by the copyright owner

   or by an individual or Legal Entity authorized to submit on behalf of

   the copyright owner. For the purposes of this definition, "submitted"

   means any form of electronic, verbal, or written communication sent

   to the Licensor or its representatives, including but not limited to

   communication on electronic mailing lists, source code control systems,

   and issue tracking systems that are managed by, or on behalf of, the

   Licensor for the purpose of discussing and improving the Work, but

   excluding communication that is conspicuously marked or otherwise

   designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity

   on behalf of whom a Contribution has been received by Licensor and

   subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of

   this License, each Contributor hereby grants to You a perpetual,

   worldwide, non-exclusive, no-charge, royalty-free, irrevocable

   copyright license to reproduce, prepare Derivative Works of,

   publicly display, publicly perform, sublicense, and distribute the

   Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of

   this License, each Contributor hereby grants to You a perpetual,

   worldwide, non-exclusive, no-charge, royalty-free, irrevocable

   (except as stated in this section) patent license to make, have made,

   use, offer to sell, sell, import, and otherwise transfer the Work,

   where such license applies only to those patent claims licensable

   by such Contributor that are necessarily infringed by their

   Contribution(s) alone or by combination of their Contribution(s)

   with the Work to which such Contribution(s) was submitted. If You

   institute patent litigation against any entity (including a

   cross-claim or counterclaim in a lawsuit) alleging that the Work

   or a Contribution incorporated within the Work constitutes direct

   or contributory patent infringement, then any patent licenses

   granted to You under this License for that Work shall terminate

   as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the

   Work or Derivative Works thereof in any medium, with or without

   modifications, and in Source or Object form, provided that You

   meet the following conditions:

   (a) You must give any other recipients of the Work or

       Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices

       stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works

       that You distribute, all copyright, patent, trademark, and

       attribution notices from the Source form of the Work,

       excluding those notices that do not pertain to any part of

       the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its

       distribution, then any Derivative Works that You distribute must

       include a readable copy of the attribution notices contained

       within such NOTICE file, excluding those notices that do not

       pertain to any part of the Derivative Works, in at least one

       of the following places: within a NOTICE text file distributed

       as part of the Derivative Works; within the Source form or

       documentation, if provided along with the Derivative Works; or,

       within a display generated by the Derivative Works, if and

       wherever such third-party notices normally appear. The contents

       of the NOTICE file are for informational purposes only and

       do not modify the License. You may add Your own attribution

       notices within Derivative Works that You distribute, alongside

       or as an addendum to the NOTICE text from the Work, provided

       that such additional attribution notices cannot be construed

       as modifying the License.

   You may add Your own copyright statement to Your modifications and

   may provide additional or different license terms and conditions

   for use, reproduction, or distribution of Your modifications, or

   for any such Derivative Works as a whole, provided Your use,

   reproduction, and distribution of the Work otherwise complies with

   the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,

   any Contribution intentionally submitted for inclusion in the Work

   by You to the Licensor shall be under the terms and conditions of

   this License, without any additional terms or conditions.

   Notwithstanding the above, nothing herein shall supersede or modify

   the terms of any separate license agreement you may have executed

   with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade

   names, trademarks, service marks, or product names of the Licensor,

   except as required for reasonable and customary use in describing the

   origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or

   agreed to in writing, Licensor provides the Work (and each

   Contributor provides its Contributions) on an "AS IS" BASIS,

   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

   implied, including, without limitation, any warranties or conditions

   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A

   PARTICULAR PURPOSE. You are solely responsible for determining the

   appropriateness of using or redistributing the Work and assume any

   risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,

   whether in tort (including negligence), contract, or otherwise,

   unless required by applicable law (such as deliberate and grossly

   negligent acts) or agreed to in writing, shall any Contributor be

   liable to You for damages, including any direct, indirect, special,

   incidental, or consequential damages of any character arising as a

   result of this License or out of the use or inability to use the

   Work (including but not limited to damages for loss of goodwill,

   work stoppage, computer failure or malfunction, or any and all

   other commercial damages or losses), even if such Contributor

   has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing

   the Work or Derivative Works thereof, You may choose to offer,

   and charge a fee for, acceptance of support, warranty, indemnity,

   or other liability obligations and/or rights consistent with this

   License. However, in accepting such obligations, You may act only

   on Your own behalf and on Your sole responsibility, not on behalf

   of any other Contributor, and only if You agree to indemnify,

   defend, and hold each Contributor harmless for any liability

   incurred by, or claims asserted against, such Contributor by reason

   of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

MIT License

Copyright (c) 2021 The Radicle Foundation

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.