[json-glib] docs: Move contribution guidelines to their own file
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [json-glib] docs: Move contribution guidelines to their own file
- Date: Tue, 8 Jun 2021 16:34:16 +0000 (UTC)
commit 3f67ed0912a90c9bca03233929291d9d6c5baf22
Author: Emmanuele Bassi <ebassi gnome org>
Date: Tue Jun 8 17:33:05 2021 +0100
docs: Move contribution guidelines to their own file
CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++
README.md | 37 -------------------------------------
2 files changed, 36 insertions(+), 37 deletions(-)
---
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..7bc45a1
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,36 @@
+# Contributing
+
+If you find a bug in JSON-GLib, please file an issue on the
+[Issues page][gitlab-issues].
+
+Required information:
+
+ * the version of JSON-GLib
+ * if it is a development version, the branch of the git repository
+ * the JSON data that produced the bug (if any)
+ * a small, self-contained test case, if none of the test units exhibit the
+ buggy behaviour
+ * in case of a segmentation fault, a full stack trace with debugging
+ symbols obtained through gdb is greatly appreaciated
+
+JSON-GLib is developed mainly inside a GIT repository available at:
+
+ https://gitlab.gnome.org/GNOME/json-glib/
+
+You can clone the GIT repository with:
+
+ git clone https://gitlab.gnome.org/GNOME/json-glib.git
+
+If you want to contribute functionality or bug fixes to JSON-GLib you should
+fork the json-glib repository, work on a separate branch, and then open a
+merge request on Gitlab:
+
+ https://gitlab.gnome.org/GNOME/json-glib/merge_requests/new
+
+Please, try to conform to the coding style used by JSON-GLib, which is the same
+used by projects like GLib, [GTK][gtk-coding-style], and Clutter. Coding style
+conformance is a requirement for upstream acceptance.
+
+Make sure you always run the test suite when you are fixing bugs. New features
+should come with a test unit. Functionality that regress the test suite will be
+rejected.
diff --git a/README.md b/README.md
index 4bde590..64d459f 100644
--- a/README.md
+++ b/README.md
@@ -50,43 +50,6 @@ To build JSON-GLib just run:
See the [Meson documentation](http://mesonbuild.com) for more information.
-Contributing
---------------------------------------------------------------------------------
-If you find a bug in JSON-GLib, please file an issue on the
-[Issues page][gitlab-issues].
-
-Required information:
-
- * the version of JSON-GLib
- * if it is a development version, the branch of the git repository
- * the JSON data that produced the bug (if any)
- * a small, self-contained test case, if none of the test units exhibit the
- buggy behaviour
- * in case of a segmentation fault, a full stack trace with debugging
- symbols obtained through gdb is greatly appreaciated
-
-JSON-GLib is developed mainly inside a GIT repository available at:
-
- https://gitlab.gnome.org/GNOME/json-glib/
-
-You can clone the GIT repository with:
-
- git clone https://gitlab.gnome.org/GNOME/json-glib.git
-
-If you want to contribute functionality or bug fixes to JSON-GLib you should
-fork the json-glib repository, work on a separate branch, and then open a
-merge request on Gitlab:
-
- https://gitlab.gnome.org/GNOME/json-glib/merge_requests/new
-
-Please, try to conform to the coding style used by JSON-GLib, which is the same
-used by projects like GLib, [GTK][gtk-coding-style], and Clutter. Coding style
-conformance is a requirement for upstream acceptance.
-
-Make sure you always run the test suite when you are fixing bugs. New features
-should come with a test unit. Patches that regress the test suite will be
-rejected.
-
Release notes
--------------------------------------------------------------------------------
* Prior to JSON-GLib 0.10, a JsonSerializable implementation could
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]