Rooba
/
bidict
mirror of https://github.com/jab/bidict.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor improvements to .envrc and CONTRIBUTING.rst

This commit is contained in:
Joshua Bronson 2023-11-01 17:23:10 -04:00
parent e2dd309aa9
commit 7ed2ce5973
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.envrc
View File

@ -1 +1,4 @@
if ! has nix_direnv_version || ! nix_direnv_version 2.4.0; then
source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/2.4.0/direnvrc" "sha256-XQzUAvL6pysIJnRJyR7uVpmUSZfc7LSgWQwq/4mBr1U="
fi
use flake use flake

16
CONTRIBUTING.rst
View File

@ -40,21 +40,27 @@ Getting Started
Making Changes Making Changes
-------------- --------------
- Recommended: You can work on bidict in a Visual Studio Code - You can work on bidict in a Visual Studio Code
`devcontainer environment <https://code.visualstudio.com/docs/remote/containers>`__, `devcontainer environment <https://code.visualstudio.com/docs/remote/containers>`__,
where development dependencies and some helpful VS Code extensions where development dependencies and some helpful VS Code extensions
are installed inside the dev container environment for you. are installed inside the dev container environment for you.
Try ``Remote-Containers: Clone Repository in Container Volume...`` on this Try ``Remote-Containers: Clone Repository in Container Volume...`` on this
repository. You may need to reload your VS Code window after it finishes repository. You may need to reload your VS Code window after it finishes
cloning and installing extensions, which it should prompt you to do. cloning and installing extensions, which it should automatically prompt you to do
when you open your clone in VS Code.
- Note that `pre-commit <https://pre-commit.com/>`__
is used to help achieve uniform style and quality standards.
- If not using a VSCode devcontainer, you can try the following - If not using a VSCode devcontainer, you can try the following
to set up a development environment manually: to set up a development environment manually:
``./init_dev_env`` ``./init_dev_env``
- Note that `pre-commit <https://pre-commit.com/>`__ This requires you to either already have Python and pre-commit on your PATH,
is used to help achieve uniform style and quality standards. or to just have Nix and direnv, in which case all development dependencies
will be auto-installed and added to your PATH in an isolated development environment
every time you cd into your clone (and auto-removed when you cd out of it).
- Create a topic branch off of ``main`` for your changes: - Create a topic branch off of ``main`` for your changes:
``git checkout -b <topic> main`` ``git checkout -b <topic> main``
@ -73,6 +79,8 @@ Making Changes
to automatically trigger a new to automatically trigger a new
`GitHub Actions <https://github.com/jab/bidict/actions>`__ build, `GitHub Actions <https://github.com/jab/bidict/actions>`__ build,
which should run the tests for all supported Python versions. which should run the tests for all supported Python versions.
Testing your changes with GitHub Actions will require approval
from a project admin the first time you submit a PR.
- Create a concise but comprehensive commit message in the following style:: - Create a concise but comprehensive commit message in the following style::