Matthew Oliver 78cce72f8a Ussuri contrib docs community goal

This patch standardizes the CONTRIBUTING.rst file and adds the
required doc/source/contributor/contributing.rst

Swift already had a detailed CONTIRBUTING.rst and an informative
REVIEW_GUIDELINES.rst in the root of the repo. So we are also pulling
them into the contributor documentation so they can not only be easily
found in the checked repo but in the online documentation.

Change-Id: I4c84efbe50eb25ab922c9d6b69198dae341af48b

2020-05-26 15:06:02 -07:00

3.2 KiB

Raw Blame History

Community

Communication

IRC: People working on the Swift project may be found in the #openstack-swift channel on Freenode during working hours in their timezone. The channel is logged, so if you ask a question when no one is around, you can check the log to see if it's been answered: http://eavesdrop.openstack.org/irclogs/%23openstack-swift/
weekly meeting: This is a Swift team meeting. The discussion in this meeting is about all things related to the Swift project:

mailing list

We use the openstack-discuss@lists.openstack.org mailing list for asynchronous discussions or to communicate with other OpenStack teams. Use the prefix [swift] in your subject line (it's a high-volume list, so most people use email filters).

More information about the mailing list, including how to subscribe and read the archives, can be found at: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss

Contacting the Core Team

The swift-core team is an active group of contributors who are responsible for directing and maintaining the Swift project. As a new contributor, your interaction with this group will be mostly through code reviews, because only members of swift-core can approve a code change to be merged into the code repository. But the swift-core team also spend time on IRC so feel free to drop in to ask questions or just to meet us.

Note

Although your contribution will require reviews by members of swift-core, these aren't the only people whose reviews matter. Anyone with a gerrit account can post reviews, so you can ask other developers you know to review your code ... and you can review theirs. (A good way to learn your way around the codebase is to review other people's patches.)

If you're thinking, "I'm new at this, how can I possibly provide a helpful review?", take a look at How to Review Changes the OpenStack Way.

Or for more specifically in a Swift context read review_guidelines

You can learn more about the role of core reviewers in the OpenStack governance documentation: https://docs.openstack.org/contributors/common/governance.html#core-reviewer

The membership list of swift-core is maintained in gerrit: https://review.opendev.org/#/admin/groups/24,members

You can also find the members of the swift-core team at the Swift weekly meetings.

Getting Your Patch Merged

Understanding how reviewers review and what they look for will help getting your code merged. See Swift Review Guidelines for how we review code.

Keep in mind that reviewers are also human; if something feels stalled, then come and poke us on IRC or add it to our meeting agenda.

Project Team Lead Duties

All common PTL duties are enumerated in the PTL guide.

3.2 KiB Raw Blame History