Skip to content

docs: added CONTRIBUTING.md#6

Open
pranavathiyani wants to merge 2 commits into
PDBeurope:masterfrom
pranavathiyani:docs/add-contributing-guide
Open

docs: added CONTRIBUTING.md#6
pranavathiyani wants to merge 2 commits into
PDBeurope:masterfrom
pranavathiyani:docs/add-contributing-guide

Conversation

@pranavathiyani
Copy link
Copy Markdown

Added a CONTRIBUTING.md to help new contributors get started.

Covers:

  • Development environment setup (uv and micromamba)
  • Branch naming and commit message conventions
  • Code style and linting with Ruff
  • Running tests with pytest
  • Building docs with MkDocs
  • Submitting PRs, reporting bugs & suggesting features

The project had no contributor guidance since the initial open-source release, so this fills that gap.

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.

1 participant