Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC Minor updates CONTRIBUTING.rst #83

Merged
merged 1 commit into from
Aug 9, 2022
Merged

DOC Minor updates CONTRIBUTING.rst #83

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ Setting up the dev environment
Following these steps you can prepare a dev environment for yourself to
contribute to `skops`.

Using conda
~~~~~~~~~~~
Using conda/mamba
~~~~~~~~~~~~~~~~~

.. code:: bash

Expand All @@ -59,11 +59,17 @@ You can also replace the above `mamba` commands with `conda` if you don't have
Running Tests
~~~~~~~~~~~~~

skops uses pytest as its test runner, just run it from the project root:

.. code:: bash

pytest

Certain tests require internet access to run, and they typically take slightly
longer to run than other tests. If you'd like to skip those tests, you can add
`-m not network` to your `pytest` command, or `-m network` to only run those
tests. For example, you can run all tests except the ones requiring internet
with:
``-m not network`` to your ``pytest`` command, or ``-m network`` to only run
those tests. For example, you can run all tests except the ones requiring
internet with:

.. code:: bash

Expand All @@ -75,18 +81,22 @@ Releases

Releases are created using `manual GitHub workflows
<https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow>`_.
Follow these steps:
As a maintainer, follow these steps:

1. Create a new branch
2. Bump the version defined in ``skops/__init__.py``
3. Git grep for any TODO's that need fixing before the release (e.g.
deprecations)
4. Update the ``CHANGES.md``
5. Create a PR with all the changes and have it reviewed and merged
6. Use the GitHub action to create a new release on **TestPyPI**. Check it for
correctness `on test.pypi <https://test.pypi.org/project/skops/>`_.
7. Use the GitHub action to create a new release on **PyPI**. Check it for
correctness `pypi <https://pypi.org/project/skops/>`_.
6. Use the `GitHub action
<https://github.com/skops-dev/skops/actions/workflows/publish-pypi.yml>`__ to
create a new release on **TestPyPI**. Check it for correctness `on test.pypi
<https://test.pypi.org/project/skops/>`_.
7. Use the `GitHub action
<https://github.com/skops-dev/skops/actions/workflows/publish-pypi.yml>`__ to
create a new release on **PyPI**. Check it for correctness `pypi
<https://pypi.org/project/skops/>`_.
8. Create a `new release <https://github.com/skops-dev/skops/releases>`_ on
GitHub
9. Update the patch version of the package to a new dev version, e.g. from
Expand Down