cleaning up and fixing some links
Verified every changed link works by building and testing manually Change-Id: I4bb6cc238d4e567e3edc6c15a58d4a5f9a41e273 Signed-off-by: Christian Ohanaja <cohanaja@nvidia.com>
This commit is contained in:
Christian Ohanaja
@@ -27,16 +27,12 @@ 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
|
you need, the basics of interacting with our Gerrit review system, how we
|
||||||
communicate as a community, etc.
|
communicate as a community, etc.
|
||||||
|
|
||||||
If you want more Swift related project documentation make sure you checkout
|
For more project information, feel free to check out the `Swift documentation <https://docs.openstack.org/swift/latest/>`__.
|
||||||
the Swift developer (contributor) documentation at
|
|
||||||
https://docs.openstack.org/swift/latest/
|
|
||||||
|
|
||||||
Filing a Bug
|
Filing a Bug
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
Filing a bug is the easiest way to contribute. We use Launchpad as a bug
|
Filing a bug is the easiest way to contribute. You can find currently-tracked bugs on our `Launchpad. <https://bugs.launchpad.net/swift>`__
|
||||||
tracker; you can find currently-tracked bugs at
|
|
||||||
https://bugs.launchpad.net/swift.
|
|
||||||
Use the `Report a bug <https://bugs.launchpad.net/swift/+filebug>`__ link to
|
Use the `Report a bug <https://bugs.launchpad.net/swift/+filebug>`__ link to
|
||||||
file a new bug.
|
file a new bug.
|
||||||
|
|
||||||
@@ -61,21 +57,20 @@ It lets us all know that the bug is very likely to be valid.
|
|||||||
Reviewing Someone Else's Code
|
Reviewing Someone Else's Code
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
All code reviews in OpenStack projects are done on
|
All code reviews in OpenStack projects are done on our Gerrit instance at
|
||||||
https://review.opendev.org/. Reviewing patches is one of the most effective
|
`review.opendev.org <https://review.opendev.org/q/project:openstack/swift+is:open>`__.
|
||||||
ways you can contribute to the community.
|
Reviewing patches is one of the most effective ways you can contribute to the community.
|
||||||
|
|
||||||
We've written REVIEW_GUIDELINES.rst (found in this source tree) to help you
|
We've written a set of `Review Guidelines <https://docs.openstack.org/swift/latest/contributor/review_guidelines.html>`__ to help you
|
||||||
give good reviews.
|
give good reviews.
|
||||||
|
|
||||||
https://wiki.openstack.org/wiki/Swift/PriorityReviews is a starting point to
|
To find out what reviews are priortiy in the community, you can read `Priority Reviews <https://wiki.openstack.org/wiki/Swift/PriorityReviews>`__ on our wiki.
|
||||||
find what reviews are priority in the community.
|
|
||||||
|
|
||||||
What do I work on?
|
What do I work on?
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
If you're looking for a way to write and contribute code, but you're not sure
|
If you're looking for a way to write and contribute code, but you're not sure
|
||||||
what to work on, check out the "wishlist" bugs in the bug tracker. These are
|
what to work on, check out the `"wishlist" bugs <https://bugs.launchpad.net/swift/+bugs?field.importance%3Alist=WISHLIST>`__ in the bug tracker. These are
|
||||||
normally smaller items that someone took the time to write down but didn't
|
normally smaller items that someone took the time to write down but didn't
|
||||||
have time to implement.
|
have time to implement.
|
||||||
|
|
||||||
@@ -87,9 +82,7 @@ Getting Started
|
|||||||
https://docs.openstack.org/swift/latest/first_contribution_swift.html
|
https://docs.openstack.org/swift/latest/first_contribution_swift.html
|
||||||
|
|
||||||
Once those steps have been completed, changes to OpenStack
|
Once those steps have been completed, changes to OpenStack
|
||||||
should be submitted for review via the Gerrit tool, following
|
should be submitted for review via the Gerrit tool, following our `Development Workflow. <http://docs.openstack.org/infra/manual/developers.html#development-workflow>`__
|
||||||
the workflow documented at
|
|
||||||
http://docs.openstack.org/infra/manual/developers.html#development-workflow.
|
|
||||||
|
|
||||||
Gerrit is the review system used in the OpenStack projects. We're sorry, but
|
Gerrit is the review system used in the OpenStack projects. We're sorry, but
|
||||||
we won't be able to respond to pull requests submitted through GitHub.
|
we won't be able to respond to pull requests submitted through GitHub.
|
||||||
@@ -100,7 +93,7 @@ not in GitHub's issue tracker.
|
|||||||
Swift Design Principles
|
Swift Design Principles
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
- `The Zen of Python <http://legacy.python.org/dev/peps/pep-0020/>`__
|
- `The Zen of Python <https://peps.python.org/pep-0020>`__
|
||||||
- Simple Scales
|
- Simple Scales
|
||||||
- Minimal dependencies
|
- Minimal dependencies
|
||||||
- Re-use existing tools and libraries when reasonable
|
- Re-use existing tools and libraries when reasonable
|
||||||
@@ -118,7 +111,7 @@ advocate for your change and iterate on it based on feedback. Reach out
|
|||||||
to other people working on the project on
|
to other people working on the project on
|
||||||
`IRC <http://eavesdrop.openstack.org/irclogs/%23openstack-swift/>`__ or
|
`IRC <http://eavesdrop.openstack.org/irclogs/%23openstack-swift/>`__ or
|
||||||
the `mailing
|
the `mailing
|
||||||
list <http://lists.openstack.org/pipermail/openstack-discuss/>`__ - we want
|
list <https://lists.openstack.org/archives/list/openstack-discuss@lists.openstack.org/>`__ - we want
|
||||||
to help.
|
to help.
|
||||||
|
|
||||||
Recommended workflow
|
Recommended workflow
|
||||||
|
|||||||
@@ -8,9 +8,10 @@ Communication
|
|||||||
IRC
|
IRC
|
||||||
People working on the Swift project may be found in the
|
People working on the Swift project may be found in the
|
||||||
``#openstack-swift`` channel on OFTC during working hours
|
``#openstack-swift`` channel on OFTC during working hours
|
||||||
in their timezone. The channel is logged, so if you ask a question
|
in their timezone. The channel is logged, so if you ask
|
||||||
when no one is around, you can check the log to see if it's been
|
a question when no one is around, you can
|
||||||
answered: http://eavesdrop.openstack.org/irclogs/%23openstack-swift/
|
`check the log <http://eavesdrop.openstack.org/irclogs/%23openstack-swift/>`__
|
||||||
|
to see if it's been answered.
|
||||||
|
|
||||||
weekly meeting
|
weekly meeting
|
||||||
This is a Swift team meeting. The discussion in this meeting is about
|
This is a Swift team meeting. The discussion in this meeting is about
|
||||||
@@ -25,9 +26,7 @@ mailing list
|
|||||||
Use the prefix ``[swift]`` in your subject line (it's a high-volume
|
Use the prefix ``[swift]`` in your subject line (it's a high-volume
|
||||||
list, so most people use email filters).
|
list, so most people use email filters).
|
||||||
|
|
||||||
More information about the mailing list, including how to subscribe
|
You can use our `mailing list info page <https://lists.openstack.org/mailman3/lists/openstack-discuss.lists.openstack.org/>`__ to read the archives and subscribe.
|
||||||
and read the archives, can be found at:
|
|
||||||
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
|
|
||||||
|
|
||||||
Contacting the Core Team
|
Contacting the Core Team
|
||||||
------------------------
|
------------------------
|
||||||
@@ -54,20 +53,17 @@ free to drop in to ask questions or just to meet us.
|
|||||||
|
|
||||||
Or for more specifically in a Swift context read :doc:`review_guidelines`
|
Or for more specifically in a Swift context read :doc:`review_guidelines`
|
||||||
|
|
||||||
You can learn more about the role of core reviewers in the OpenStack
|
You can read about the role of core reviewers in the
|
||||||
governance documentation:
|
`OpenStack governance documentation
|
||||||
https://docs.openstack.org/contributors/common/governance.html#core-reviewer
|
<https://docs.openstack.org/contributors/common/governance.html#core-reviewer>`_, learn
|
||||||
|
more about the swift-core members in our gerrit
|
||||||
The membership list of swift-core is maintained in gerrit:
|
`membership list <https://review.opendev.org/#/admin/groups/24,members>`__, and
|
||||||
https://review.opendev.org/#/admin/groups/24,members
|
also find the team at our `Swift weekly meetings <#communication>`__.
|
||||||
|
|
||||||
You can also find the members of the swift-core team at the Swift weekly
|
|
||||||
meetings.
|
|
||||||
|
|
||||||
Getting Your Patch Merged
|
Getting Your Patch Merged
|
||||||
-------------------------
|
-------------------------
|
||||||
Understanding how reviewers review and what they look for will help getting
|
Understanding how reviewers review and what they look for will help getting
|
||||||
your code merged. See `Swift Review Guidelines <contributor/review_guidelines>`_
|
your code merged. See `Swift Review Guidelines <https://docs.openstack.org/swift/latest/contributor/review_guidelines.html>`_
|
||||||
for how we review code.
|
for how we review code.
|
||||||
|
|
||||||
Keep in mind that reviewers are also human; if something feels stalled, then
|
Keep in mind that reviewers are also human; if something feels stalled, then
|
||||||
|
|||||||
Reference in New Issue
Block a user