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

Fix copy button for shell snippets #637

Merged
merged 1 commit into from
Jan 11, 2025
Merged

Fix copy button for shell snippets #637

Show file tree
Hide file tree
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
28 changes: 19 additions & 9 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Setting Up for Local Development

1. Fork marshmallow-sqlalchemy_ on Github.

::
.. code-block:: shell-session

$ git clone https://github.com/marshmallow-code/marshmallow-sqlalchemy.git
$ cd marshmallow-sqlalchemy
Expand All @@ -22,14 +22,14 @@ Setting Up for Local Development
Use the following command to install an editable version of
marshmallow-sqlalchemy along with its development requirements.

::
.. code-block:: shell-session

# After activating your virtualenv
$ pip install -e '.[dev]'

3. Install the pre-commit hooks, which will format and lint your git staged files.

::
.. code-block:: shell-session

# The pre-commit CLI was installed above
$ pre-commit install --allow-missing-config
Expand All @@ -38,7 +38,8 @@ Pull Requests
--------------

1. Create a new local branch.
::

.. code-block:: shell-session

# For a new feature
$ git checkout -b name-of-feature dev
Expand All @@ -47,7 +48,8 @@ Pull Requests
$ git checkout -b fix-something 1.2-line

2. Commit your changes. Write `good commit messages <http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.
::

.. code-block:: shell-session

$ git commit -m "Detailed commit message"
$ git push origin name-of-feature
Expand All @@ -64,15 +66,21 @@ Pull Requests
Running Tests
-------------

To run all To run all tests: ::
To run all To run all tests:

.. code-block:: shell-session

$ pytest

To run formatting and syntax checks: ::
To run formatting and syntax checks:

.. code-block:: shell-session

$ tox -e lint

(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed): ::
(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed):

.. code-block:: shell-session

$ tox

Expand All @@ -81,7 +89,9 @@ Documentation

Contributions to the documentation are welcome. Documentation is written in `reStructuredText`_ (rST). A quick rST reference can be found `here <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_. Builds are powered by Sphinx_.

To build the docs in "watch" mode: ::
To build the docs in "watch" mode:

.. code-block:: shell-session

$ tox -e watch-docs

Expand Down
3 changes: 2 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ Make sure to declare `Models` before instantiating `Schemas`. Otherwise `sqlalch

Get it now
==========
::

.. code-block:: shell-session

pip install -U marshmallow-sqlalchemy

Expand Down
Loading