openstack/openstack-manuals
Code Issues Proposed changes

Adds new CONTRIBUTING.txt and updates README.rst

Browse Source 
* 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
This commit is contained in:
Anne Gentle 2017-01-02 20:44:12 -06:00 committed by Alexandra Settle
parent f5002f336b
commit 44efc50ac5
2 changed files with 37 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
CONTRIBUTING.rst Normal file
View File

@ -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
<https://www.openstack.org/join>`_.
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 <https://wiki.openstack.org>`_, 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
<http://docs.openstack.org/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

19
README.rst
View File

@ -76,25 +76,6 @@ tox will use the openstack-doc-tools package for execution of these
tests. tests.
Contributing
============
Our community welcomes all people interested in open source cloud
computing, and encourages you to join the `OpenStack Foundation
<https://www.openstack.org/join>`_.
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 <https://wiki.openstack.org>`_, 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
<http://docs.openstack.org/contributor-guide/>`_.
Generated files Generated files
--------------- ---------------