Skip to content

Contribution guide update, configuration page fix.#2544

Merged
freakboy3742 merged 3 commits intobeeware:mainfrom
kattni:docs/dep-groups-contribution-update
Oct 29, 2025
Merged

Contribution guide update, configuration page fix.#2544
freakboy3742 merged 3 commits intobeeware:mainfrom
kattni:docs/dep-groups-contribution-update

Conversation

@kattni
Copy link
Contributor

@kattni kattni commented Oct 29, 2025

  • Updates the code contribution guide to refer to dependency groups for pip install.
  • Updates headings in the configuration reference.

Fixes #2543

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

$ python3 -m venv .venv
$ . .venv/bin/activate
(.venv) $ python -m pip install -Ue ".[dev]"
(.venv) $ python -m pip install -Ue --group dev
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "." is significant - it's saying "install this directory". It's essentially pip install -e .:

Suggested change
(.venv) $ python -m pip install -Ue --group dev
(.venv) $ python -m pip install -Ue . --group dev

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok, I thought it was part of installing using the previous method. Updated.

Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@freakboy3742 freakboy3742 merged commit f2a213e into beeware:main Oct 29, 2025
57 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Configuration documentation section structure is wrong

2 participants