From abf50fe06c305ed26af98d0ddac82d1523acb83b Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Thu, 13 May 2021 19:04:28 -0500 Subject: [PATCH] [ussuri][goal] Update contributor documentation This patch updates/adds the contributor documentation to follow the guidelines of the Ussuri cycle community goal[1]. [1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html Story: #2007236 Task: #38522 Change-Id: Id2d951e5a080565796f765f70c678c78bb3958da --- CONTRIBUTING.rst | 19 ++++++++++ doc/source/contributor/contributing.rst | 47 +++++++++++++++++++++++++ doc/source/index.rst | 8 +++++ 3 files changed, 74 insertions(+) create mode 100644 CONTRIBUTING.rst create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..5d04e4d --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,19 @@ +The source repository for this project can be found at: + + https://opendev.org/openstack/freezer-web-ui + +Pull requests submitted through GitHub are not monitored. + +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 + +Bugs should be filed on Storyboard: + + https://storyboard.openstack.org/#!/project/openstack/freezer-web-ui + +For more specific information about contributing to this repository, see the +freezer-web-ui contributor guide: + + https://opendev.org/openstack/freezer-web-ui/src/branch/master/doc/source/contributor/contributing.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..1b18278 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,47 @@ +============================ +So You Want to Contribute... +============================ +For general information on contributing to OpenStack, please check out the +`contributor guide `_ to get started. +It covers all the basics that are common to all OpenStack projects: the accounts +you need, the basics of interacting with our Gerrit review system, how we +communicate as a community, etc. +Below will cover the more project specific information you need to get started +with freezer-web-ui. + +Communication +~~~~~~~~~~~~~ +* IRC channel #openstack-freezer at OFTC +* Mailing list (prefix subjects with ``[freezer]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `freezer-web-ui Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +freezer-web-ui features are tracked on `Storyboard `_. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Storyboard `_. +If you're looking for some smaller, easier work item to pick up and get started +on, search for the 'low-hanging-fruit' tag. + +Reporting a Bug +~~~~~~~~~~~~~~~ +You found an issue and want to make sure we are aware of it? You can do so on +`Storyboard `_. + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the freezer-web-ui project require one +2 votes +from freezer-web-ui core reviewers with approving patch by giving +``Workflow +1`` vote. + +Project Team Lead Duties +~~~~~~~~~~~~~~~~~~~~~~~~ +All common PTL duties are enumerated in the `PTL guide +`_. diff --git a/doc/source/index.rst b/doc/source/index.rst index 61b4561..bef8acb 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,7 +11,15 @@ Contents: .. toctree:: :maxdepth: 2 +For Contributors +================ +* If you are a new contributor to freezer-web-ui please refer: :doc:`contributor/contributing` + + .. toctree:: + :hidden: + + contributor/contributing Indices and tables ==================