From 44efc50ac52fb463f64a79e7abc7a7e4ba5522d5 Mon Sep 17 00:00:00 2001 From: Anne Gentle Date: Mon, 2 Jan 2017 20:44:12 -0600 Subject: [PATCH] Adds new CONTRIBUTING.txt and updates README.rst * In response to openstack-dev ML thread at http://lists.openstack.org/pipermail/openstack-dev/2016-December/109294.html * Proof-of-concept that we would get both a GitHub UI addition of a linked CONTRIBUTING file as well as a Sphinx include directive in the more detailed contributor guide. Change-Id: Ibe4c46faa25697eac4819d8ff1b2722fe58f23bf --- CONTRIBUTING.rst | 37 +++++++++++++++++++++++++++++++++++++ README.rst | 19 ------------------- 2 files changed, 37 insertions(+), 19 deletions(-) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000000..4438f88b0e --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,37 @@ +================= +How to contribute +================= + +Our community welcomes all people interested in open source cloud +computing, and encourages you to join the `OpenStack Foundation +`_. + +The best way to get involved with the community is to talk with others +online or at a meet up and offer contributions through our processes, +the `OpenStack wiki `_, blogs, or on IRC at +``#openstack`` on ``irc.freenode.net``. + +We welcome all types of contributions, from blueprint designs to +documentation to testing to deployment scripts. + +If you would like to contribute to the documents, please see the +`OpenStack Documentation Contributor Guide +`_. + +If you would like to contribute to the development of OpenStack, you must +follow the steps in this page: + + http://docs.openstack.org/infra/manual/developers.html + +If you already have a good understanding of how the system works and your +OpenStack accounts are set up, you can skip to the development workflow +section of this documentation to learn how changes to OpenStack should be +submitted for review via the Gerrit tool: + + http://docs.openstack.org/infra/manual/developers.html#development-workflow + +Pull requests submitted through GitHub will be ignored. + +Bugs should be filed on Launchpad, not GitHub: + + https://bugs.launchpad.net/openstack-manuals diff --git a/README.rst b/README.rst index b1224feea7..c1bc679a01 100644 --- a/README.rst +++ b/README.rst @@ -76,25 +76,6 @@ tox will use the openstack-doc-tools package for execution of these tests. -Contributing -============ - -Our community welcomes all people interested in open source cloud -computing, and encourages you to join the `OpenStack Foundation -`_. - -The best way to get involved with the community is to talk with others -online or at a meet up and offer contributions through our processes, -the `OpenStack wiki `_, blogs, or on IRC at -``#openstack`` on ``irc.freenode.net``. - -We welcome all types of contributions, from blueprint designs to -documentation to testing to deployment scripts. - -If you would like to contribute to the documents, please see the -`OpenStack Documentation Contributor Guide -`_. - Generated files ---------------