-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Reformat the contributing guide
- Loading branch information
Showing
1 changed file
with
24 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,29 @@ | ||
# Contributing to Vodozemac | ||
# Contributing to vodozemac | ||
|
||
Thank you for taking the time to contribute to Matrix! | ||
|
||
This is the repository for Vodozemac, a Rust implementation of Olm and Megolm. | ||
|
||
## Sign off | ||
|
||
We ask that everybody who contributes to this project signs off their contributions, as explained below. | ||
|
||
We follow a simple 'inbound=outbound' model for contributions: the act of submitting an 'inbound' contribution means that the contributor agrees to license their contribution under the same terms as the project's overall 'outbound' license - in our case, this is Apache Software License v2 (see [LICENSE](./LICENSE)). | ||
|
||
In order to have a concrete record that your contribution is intentional and you agree to license it under the same terms as the project's license, we've adopted the same lightweight approach used by the [Linux Kernel](https://www.kernel.org/doc/html/latest/process/submitting-patches.html), [Docker](https://github.com/docker/docker/blob/master/CONTRIBUTING.md), and many other projects: the [Developer Certificate of Origin](https://developercertificate.org/) (DCO). This is a simple declaration that you wrote the contribution or otherwise have the right to contribute it to Matrix: | ||
We ask that everybody who contributes to this project signs off their | ||
contributions, as explained below. | ||
|
||
We follow a simple 'inbound=outbound' model for contributions: the act of | ||
submitting an 'inbound' contribution means that the contributor agrees to | ||
license their contribution under the same terms as the project's overall | ||
'outbound' license - in our case, this is Apache Software License v2 (see | ||
[LICENSE](./LICENSE)). | ||
|
||
In order to have a concrete record that your contribution is intentional and you | ||
agree to license it under the same terms as the project's license, we've adopted | ||
the same lightweight approach used by the [Linux | ||
Kernel](https://www.kernel.org/doc/html/latest/process/submitting-patches.html), | ||
[Docker](https://github.com/docker/docker/blob/master/CONTRIBUTING.md), and many | ||
other projects: the [Developer Certificate of | ||
Origin](https://developercertificate.org/) (DCO). This is a simple declaration | ||
that you wrote the contribution or otherwise have the right to contribute it to | ||
Matrix: | ||
|
||
``` | ||
Developer Certificate of Origin | ||
|
@@ -50,10 +63,13 @@ By making a contribution to this project, I certify that: | |
this project or the open source license(s) involved. | ||
``` | ||
|
||
If you agree to this for your contribution, then all that's needed is to include the line in your commit or pull request comment: | ||
If you agree to this for your contribution, then all that's needed is to include | ||
the line in your commit or pull request comment: | ||
|
||
``` | ||
Signed-off-by: Your Name <[email protected]> | ||
``` | ||
|
||
Git allows you to add this signoff automatically when using the `-s` flag to `git commit`, which uses the name and email set in your `user.name` and `user.email` git configs. | ||
Git allows you to add this signoff automatically when using the `-s` flag to | ||
`git commit`, which uses the name and email set in your `user.name` and | ||
`user.email` git configs. |