Pull Request Walkthrough
========================
Changes to pulpcore are submitted via `GitHub Pull Requests (PR)
`_ to the `pulp git repository
`_ . Plugin git repositories are listed in the `plugin table
`_.
Boilerplate
-----------
If you would like to submit a patch, especially if you have a major change, it is recommended that
you :ref:`chat with us` before you get started.
#. `Fork `_
`pulpcore `_ in your GitHub account.
#. :doc:`Install Pulp from source.`
#. Create a new branch from the :ref:`appropriate base branch`
#. Review the :doc:`style-guide`.
Checklist
---------
#. Add :ref:`unit tests` where appropriate.
#. Update relevent :doc:`documentation`. Please build the docs to test!
#. If your change would benefit from integration testing, write a `pulp smash issue
`_.
#. Add a :ref:`changelog update `.
#. :ref:`Rebase and squash` to a single commit, if appropriate.
#. Write an excellent :ref:`commit-message`. Make sure you reference and link to the issue.
#. Push your branch to your fork and open a `Pull request across forks
`_.
#. Add GitHub labels as appropriate.
#. Change the status of the redmine issue to "POST".
#. Add a link to the pull request in a comment on the issue.
#. Make sure the tests are passing.
Review
------
Before a pull request can be merged, the :ref:`tests` must pass and it must
be reviewed by one of the committers. We encourage you to :ref:`reach out to the
developers` to get speedy review.
.. note::
*To the community:* The Pulp Team is very grateful for your contribution and values your
involvement tremendously! There are few things in an OSS project as satisfying as receiving a
pull request from the community.
We are very open and honest when we review each other's work. We will do our best to review your
contribution with respect and professionalism. In return, we hope you will accept our review
process as an opportunity for everyone to learn something, and to make Pulp the best project it
can be. If you are uncertain about comments or instructions, please let us know!
Reviewing a Pull Request
------------------------
When reviewing a PR, it is important to consider where the change ought to land. If you are
reviewing a bug fix that might be released as part of a z-stream release, you should add the "Needs
Cherry Pick" label to the PR. Otherwise the label should be removeed. PR authors can also add or
remove this label if they have write access.