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

doc: Add directions for using dev containers #237

Merged
merged 7 commits into from
Mar 20, 2025
Merged

doc: Add directions for using dev containers #237

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9fed7ce
doc: Add directions for using dev containers
fruitymedley Mar 17, 2025
0d74740
doc: add multiple setup options
fruitymedley Mar 18, 2025
4aa70e1
doc: refer readme to docs
fruitymedley Mar 18, 2025
fd4a0de
doc: Fix git links
fruitymedley Mar 19, 2025
944f2e6
doc: clarify variable
fruitymedley Mar 19, 2025
f84d0d1
doc: move obsolete tutorial to todo
fruitymedley Mar 19, 2025
29b02ec
doc: Fix git links again
fruitymedley Mar 20, 2025
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
18 changes: 9 additions & 9 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,21 +145,20 @@ Clone the repository
git clone [email protected]:YourLogin/strawberry-sqlalchemy-mapper.git
cd strawberry-sqlalchemy-mapper

#. You should run::
Open the Dev Container
----------------------

pip install -U pip setuptools -e .
#. Install `Dev Containers`_.

to be able to import the package under development in the Python REPL.
#. Press ``Ctrl+Shift+P`` to open the command tab and enter ``Dev Containers: Open Folder in Container...``.

.. todo:: if you are not using pre-commit, please remove the following item:
#. Select the root directory of this repository.
Dev Containers will now install the environment dependencies as well as |pre-commit|_

#. Install |pre-commit|_::
#. When installation is complete, press ``Ctrl+Shift+P`` to open the command tab and enter ``Python Select Interpreter``

pip install pre-commit
pre-commit install
#. Select the environment labeled 'poetry'.

``strawberry-sqlalchemy-mapper`` comes with a lot of hooks configured to automatically help the
developer to check the code being written.

Implement your changes
----------------------
Expand Down Expand Up @@ -329,6 +328,7 @@ on PyPI_, the following steps can be used to release a new version for
.. _contribution-guide.org: https://www.contribution-guide.org/
.. _creating a PR: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
.. _descriptive commit message: https://chris.beams.io/posts/git-commit
.. _Dev Containers: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
.. _docstrings: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
.. _first-contributions tutorial: https://github.com/firstcontributions/first-contributions
.. _flake8: https://flake8.pycqa.org/en/stable/
Expand Down
Loading