From a1b977c68329c1ece5dfb9aaa30246803c23e1ee Mon Sep 17 00:00:00 2001 From: Chenxiong Qi Date: Mar 15 2017 12:03:56 +0000 Subject: [PATCH 1/2] More document in README README file is reformatted in format reStructuredText based on existing content. In addition, add a new section Contribution for fixing issue 189, that mentions what a contributor needs to do to propose changes to rpkg. Fix #189 Signed-off-by: Chenxiong Qi --- diff --git a/README b/README deleted file mode 100644 index b49056d..0000000 --- a/README +++ /dev/null @@ -1,9 +0,0 @@ -This is the rpkg project, which mostly is a python library for dealing with -rpm packaging in a git source control. pyrpkg is the base library that sites -can subclass to create useful tools. - -Unless otherwise specified, all files are licensed under GPLv2+. -There are parts of koji code in pyrpkg/cli, those parts are licensed -under LGPLv2(.1). See COPYING-koji for that license statement. - -See https://pagure.io/rpkg for more information, bug tracking, etc. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..adf8cbd --- /dev/null +++ b/README.rst @@ -0,0 +1,33 @@ +Introduction +============ + +This is the rpkg project, which mostly is a python library for dealing with +rpm packaging in a git source control. pyrpkg is the base library that sites +can subclass to create useful tools. + +License +======= + +Unless otherwise specified, all files are licensed under GPLv2+. +There are parts of koji code in pyrpkg/cli, those parts are licensed +under LGPLv2(.1). See COPYING-koji for that license statement. + +Contribution +============ + +Welcome to write patches to fix or improve rpkg. All code should work well with +Python 2.6 and 2.7, and compatibility with Python 3 would be a big bonus. +Before you create a PR to propose your changes, make sure + +* to sign-off your commits by ``git commit -s``. This serves as a confirmation + that you have the right to submit your changes. See `Developer Certificate of + Origin`_ for details. + +* pass all test cases by running ``python setup.py test``. + +.. _Developer Certificate of Origin: https://developercertificate.org/ + +More Information +================ + +See https://pagure.io/rpkg for more information, bug tracking, etc. From 83d747f07f83ecb332ba041f339df0511f45adb3 Mon Sep 17 00:00:00 2001 From: Chenxiong Qi Date: Mar 15 2017 12:03:56 +0000 Subject: [PATCH 2/2] Include README.rst in dist package Signed-off-by: Chenxiong Qi --- diff --git a/MANIFEST.in b/MANIFEST.in index 4d95976..3f8b370 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -2,6 +2,7 @@ include COPYING include COPYING-koji include LGPL include CHANGELOG.rst +include README.rst include doc/rpkg_man_page.py include bin/rpkg recursive-include tests *