Skip to content

Update documentation and contribution instructions - #1435

Merged
dantownsend merged 4 commits into
piccolo-orm:masterfrom
mlbiche:update-doc-and-contribution
Sep 14, 2026
Merged

dantownsend merged 4 commits into
piccolo-orm:masterfrom
mlbiche:update-doc-and-contribution

Conversation

@mlbiche

@mlbiche mlbiche commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

This PR updates contribution instructions for code styling. It also adds an example of the expected fixtures file structure.

Finally, it also introduces an optional Docker composition for an easy setup of the test environment.

@dantownsend
dantownsend self-requested a review September 11, 2026 15:47

@dantownsend dantownsend left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good - thanks! Just some small comments.

Comment on lines +79 to +83
"black-formatter.importStrategy": "fromEnvironment",
"black-formatter.args": ["--line-length", "79"],
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter"
},

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Good catch, thanks!

Comment on lines +76 to +78
"mypy-type-checker.reportingScope": "workspace",
"mypy-type-checker.preferDaemon": true,
"mypy-type-checker.importStrategy": "fromEnvironment",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I get Unknown Configuration Setting on my machine with these - maybe I have something setup wrong (missing extensions or something). I'll take a look.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Indeed, as stated just above in the doc, extensions are now required. The linked to extensions are mentioned above.

.. code-block:: json

{
"my_wonderfull_piccolo_app": {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Small typo here -> wonderful.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks!

@dantownsend

Copy link
Copy Markdown
Member

Looks good, thanks!

@dantownsend
dantownsend merged commit 2556bbf into piccolo-orm:master Sep 14, 2026
41 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.

2 participants