From fbf531b810a11861c326c98cbe50ff3c8c6b8041 Mon Sep 17 00:00:00 2001 From: Johan Malm Date: Fri, 3 Dec 2021 22:44:06 +0000 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++++++ README.md | 5 ----- 2 files changed, 12 insertions(+), 5 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a2b22f8e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,12 @@ +# How to Contribute + +Let's try to stick to sircmpwn's [coding style] + +And write [commit messages] like so, keeping the top line to this sort of syntax: + +``` +cursor: add special feature +``` + +[coding style]: https://git.sr.ht/~sircmpwn/cstyle +[commit messages]: https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/CONTRIBUTING.md#commit-messages diff --git a/README.md b/README.md index bfb5aa0a..ff643b59 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ - [5. Run](#5-run) - [6. Integrate](#6-integrate) - [7. Roadmap](#7-roadmap) -- [8. Contribute](#7-contribute) ## 1. What is this? @@ -150,9 +149,6 @@ High-level summary of items which are not inteded to be implemented: - Any theme option not required to reasonably render common themes (it's amazing how few options are actually required). -## 8. Contribute - -Let's try to stick to this [coding style] [openbox-3.4]: http://openbox.org/wiki/Help:Contents [rc.xml]: docs/rc.xml @@ -193,4 +189,3 @@ Let's try to stick to this [coding style] [Video (1:10)]: https://youtu.be/AU_M3n_FS-E [Video (3:42)]: https://youtu.be/rE1bQjSVJzg -[coding style]: https://git.sr.ht/~sircmpwn/cstyle -- 2.52.0