Add contributing page and some updates

The commit adds contributing page for easier orientation
in our projects.

Change-Id: I1045f1940d5ead7b1dfdbf5ecaf09b9a38a4606e
This commit is contained in:
Martin Kopec 2021-11-07 16:57:06 +00:00
parent ef6e804cca
commit ffcdca681b
5 changed files with 74 additions and 12 deletions

View File

@ -5,19 +5,34 @@
- openstack-python3-yoga-jobs - openstack-python3-yoga-jobs
check: check:
jobs: jobs:
- refstack-client-devstack-master - refstack-client-devstack-master:
- refstack-client-devstack-wallaby # Define a list of irrelevant files to use everywhere else
- refstack-client-devstack-victoria irrelevant-files: &refstack-client-irrelevant-files
- refstack-client-devstack-ussuri - ^.*\.rst$
- refstack-client-devstack-train - ^doc/.*$
- ^.gitignore$
- ^.gitreview$
- refstack-client-devstack-wallaby:
irrelevant-files: *refstack-client-irrelevant-files
- refstack-client-devstack-victoria:
irrelevant-files: *refstack-client-irrelevant-files
- refstack-client-devstack-ussuri:
irrelevant-files: *refstack-client-irrelevant-files
- refstack-client-devstack-train:
irrelevant-files: *refstack-client-irrelevant-files
- opendev-tox-docs - opendev-tox-docs
gate: gate:
jobs: jobs:
- refstack-client-devstack-master - refstack-client-devstack-master:
- refstack-client-devstack-wallaby irrelevant-files: *refstack-client-irrelevant-files
- refstack-client-devstack-victoria - refstack-client-devstack-wallaby:
- refstack-client-devstack-ussuri irrelevant-files: *refstack-client-irrelevant-files
- refstack-client-devstack-train - refstack-client-devstack-victoria:
irrelevant-files: *refstack-client-irrelevant-files
- refstack-client-devstack-ussuri:
irrelevant-files: *refstack-client-irrelevant-files
- refstack-client-devstack-train:
irrelevant-files: *refstack-client-irrelevant-files
- opendev-tox-docs - opendev-tox-docs
promote: promote:
jobs: jobs:

34
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,34 @@
The source repository for this project can be found at:
https://opendev.org/openinfra/refstack-client
To start contributing to OpenStack, follow the steps in the contribution guide
to set up and use Gerrit:
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Documentation of the project can be found at:
https://docs.opendev.org/openinfra/refstack-client/latest/
Bugs should be filed on Storyboard:
https://storyboard.openstack.org/#!/project/openinfra/refstack-client
Patches against this project can be found at:
https://review.opendev.org/q/project:openinfra/refstack-client
To communicate with us you may use one of the following means:
**Mailing List:**
Get in touch with us via `email <mailto:openstack-discuss@lists.openstack.org>`_.
Use [refstack-client] in your subject.
**IRC:**
We're at #refstack channel on OFTC network.
`Setup IRC <https://docs.openstack.org/contributors/common/irc.html>`_
**Meetings:**
`Visit this link <https://meetings.opendev.org/#Interop_Working_Group_Meeting>`_
for the meeting information.

View File

@ -209,6 +209,13 @@ integrated to an automation machinery - f.e. we use the role for running
every OpenStack Marketing Program of the current guideline. The latest builds every OpenStack Marketing Program of the current guideline. The latest builds
can be found here__. can be found here__.
.. _ansible-role-refstack-client: https://opendev.org/x/ansible-role-refstack-client .. _ansible-role-refstack-client: https://opendev.org/openinfra/ansible-role-refstack-client
.. _devstack: https://opendev.org/openstack/devstack/ .. _devstack: https://opendev.org/openstack/devstack/
.. __builds: https://zuul.openstack.org/builds?project=x%2Fansible-role-refstack-client .. __builds: https://zuul.openstack.org/builds?project=openinfra%2Fansible-role-refstack-client
Get Involved
############
See the `CONTRIBUTING <https://docs.opendev.org/openinfra/refstack-client/latest/contributing.html>`_
guide on how to get involved.

View File

@ -0,0 +1,5 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst

View File

@ -10,6 +10,7 @@ About refstack-client
:maxdepth: 2 :maxdepth: 2
readme readme
contributing
----------------- -----------------
Approved Features Approved Features