[1/2] Add CONTRIBUTING.md

Submitted by Mike Rapoport on June 9, 2020, 1:52 p.m.

Details

Message ID 20200609135211.1391518-2-rppt@linux.ibm.com
State New
Series "Add CONTRIBUTING.md"
Headers show

Commit Message

Mike Rapoport June 9, 2020, 1:52 p.m.
Move the existing contribution guidelines to a dedicated file for future
extensions.

Signed-off-by: Mike Rapoport <rppt@linux.ibm.com>
---
 CONTRIBUTING.md | 19 +++++++++++++++++++
 README.md       | 20 +++++---------------
 2 files changed, 24 insertions(+), 15 deletions(-)
 create mode 100644 CONTRIBUTING.md

Patch hide | download patch | download mbox

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..342619e88
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,19 @@ 
+[![master](https://travis-ci.org/checkpoint-restore/criu.svg?branch=master)](https://travis-ci.org/checkpoint-restore/criu)
+[![development](https://travis-ci.org/checkpoint-restore/criu.svg?branch=criu-dev)](https://travis-ci.org/checkpoint-restore/criu)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/55251ec7db28421da4481fc7c1cb0cee)](https://www.codacy.com/app/xemul/criu?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=xemul/criu&amp;utm_campaign=Badge_Grade)
+<p align="center"><img src="https://criu.org/w/images/1/1c/CRIU.svg" width="128px"/></p>
+
+## How to contribute to CRIU
+
+CRIU project is (almost) the never-ending story, because we have to always keep up with the
+Linux kernel supporting checkpoint and restore for all the features it provides. Thus we're
+looking for contributors of all kinds -- feedback, bug reports, testing, coding, writing, etc.
+Here are some useful hints to get involved.
+
+* We have both -- [very simple](https://github.com/checkpoint-restore/criu/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) and [more sophisticated](https://github.com/checkpoint-restore/criu/issues?q=is%3Aissue+is%3Aopen+label%3A%22new+feature%22) coding tasks;
+* CRIU does need [extensive testing](https://github.com/checkpoint-restore/criu/issues?q=is%3Aissue+is%3Aopen+label%3Atesting);
+* Documentation is always hard, we have [some information](https://criu.org/Category:Empty_articles) that is to be extracted from people's heads into wiki pages as well as [some texts](https://criu.org/Category:Editor_help_needed) that all need to be converted into useful articles;
+* Feedback is expected on the github issues page and on the [mailing list](https://lists.openvz.org/mailman/listinfo/criu);
+* We accept github pull requests and this is the preferred way to contribute to CRIU. If you prefer to send patches by email, you are welcome to send them to [the devel list](http://criu.org/How_to_submit_patches);
+* Spread the word about CRIU in [social networks](http://criu.org/Contacts);
+* If you're giving a talk about CRIU -- let us know, we'll mention it on the [wiki main page](https://criu.org/News/events);
diff --git a/README.md b/README.md
index 6a578b953..d703638ec 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,11 @@  project is that it is mainly implemented in user space. There are some more proj
 doing C/R for Linux, and so far CRIU [appears to be](https://criu.org/Comparison_to_other_CR_projects) 
 the most feature-rich and up-to-date with the kernel.
 
+CRIU project is (almost) the never-ending story, because we have to always keep up with the
+Linux kernel supporting checkpoint and restore for all the features it provides. Thus we're
+looking for contributors of all kinds -- feedback, bug reports, testing, coding, writing, etc.
+Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) if you would like to get involved.
+
 The project [started](https://criu.org/History) as the way to do live migration for OpenVZ
 Linux containers, but later grew to more sophisticated and flexible tool. It is currently 
 used by (integrated into) OpenVZ, LXC/LXD, Docker, and other software, project gets tremendous 
@@ -56,21 +61,6 @@  One of the CRIU features is the ability to save and restore state of a TCP socke
 without breaking the connection. This functionality is considered to be useful by
 itself, and we have it available as the [libsoccr library](https://criu.org/Libsoccr).
 
-## How to contribute
-
-CRIU project is (almost) the never-ending story, because we have to always keep up with the
-Linux kernel supporting checkpoint and restore for all the features it provides. Thus we're
-looking for contributors of all kinds -- feedback, bug reports, testing, coding, writing, etc.
-Here are some useful hints to get involved.
-
-* We have both -- [very simple](https://github.com/checkpoint-restore/criu/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) and [more sophisticated](https://github.com/checkpoint-restore/criu/issues?q=is%3Aissue+is%3Aopen+label%3A%22new+feature%22) coding tasks;
-* CRIU does need [extensive testing](https://github.com/checkpoint-restore/criu/issues?q=is%3Aissue+is%3Aopen+label%3Atesting);
-* Documentation is always hard, we have [some information](https://criu.org/Category:Empty_articles) that is to be extracted from people's heads into wiki pages as well as [some texts](https://criu.org/Category:Editor_help_needed) that all need to be converted into useful articles;
-* Feedback is expected on the github issues page and on the [mailing list](https://lists.openvz.org/mailman/listinfo/criu);
-* We accept github pull requests and this is the preferred way to contribute to CRIU. If you prefer to send patches by email, you are welcome to send them to [the devel list](http://criu.org/How_to_submit_patches);
-* Spread the word about CRIU in [social networks](http://criu.org/Contacts);
-* If you're giving a talk about CRIU -- let us know, we'll mention it on the [wiki main page](https://criu.org/News/events);
-
 ## Licence
 
 The project is licensed under GPLv2 (though files sitting in the lib/ directory are LGPLv2.1).