From 5a9eeb64495465ceb116cdb46197b55e215add22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Fri, 26 Jul 2024 14:43:42 +0200 Subject: [PATCH] chore: Reformat the contributing guide --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1741b334..f165ddd5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to Vodozemac +# Contributing to vodozemac Thank you for taking the time to contribute to Matrix! @@ -6,11 +6,24 @@ 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 ``` -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. \ No newline at end of file +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.