Contributing ============ Contribution documentation generally assumes that the reader is familiar with :doc:`Pulp basics`. If you have problems, you can :ref:`contact us` or :doc:`file an issue`. Workflow -------- 1. Clone the GitHub repo 2. Make a change 3. Make sure all tests passed 4. Add a file into CHANGES folder for user facing changes and CHANGES/plugin_api for plugin API changes. 5. Commit changes to own ``pulpcore`` clone 6. Make pull request from github page for your clone against master branch Fundamentals ------------ .. toctree:: :maxdepth: 1 dev-setup tests style-guide documentation git pull-request-walkthrough Plugin Development ------------------ Developers interested in writing plugins should reference the `Pulp Plugin API <../plugins/index.html>`_ documentation. Reference --------- .. toctree:: :maxdepth: 1 architecture/index platform-api/index Suggesting Changes to the Pulp Development Process -------------------------------------------------- Pulp is a community project, and major changes to the way Pulp is developed, such as the release cycle, and style guide, can be suggested by submitting a :term:`PUP`, or, "Pulp Update Proposal". All approved PUPs live in the `PUP repository `_. `PUP-1 `_ defines the PUP process itself. All approved, rejected, and abandoned PUPs are tracked in the `PUP index `_