-
Notifications
You must be signed in to change notification settings - Fork 19
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.
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
Added basic contributing notes #56
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs the changes as per #55
README.md
Outdated
``` | ||
|
||
You can run tests for a specific environment `tox -e python3.11-django4.2-wagtail5.0`, or run a specific test | ||
`tox -e python3.11-django4.2-wagtail5.0 tests.test.test_blocks.TestBlocks` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`tox -e python3.11-django4.2-wagtail5.0 tests.test.test_blocks.TestBlocks` | |
`tox -e python3.11-django4.2-wagtail5.0 -- tests.test.test_blocks.TestBlocks` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm sorry, I thought for sure I ran the command without run
and it worked without the --
but after your comment, I can't get it to work without the --
no matter how it's called. I also can't get the wagtailmedia instructions to work in a completely isolated and clean environment, so may need to fix things there as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've update the wagtailmedia README just now. Thanks for the reminder
eeda99c
to
83092c0
Compare
Thank you @jsma |
Thank you @zerolab! |
* Cleanup RichTextBlockWithFootnotes (#2) * Cleanup RichTextBlockWithFootnotes * Make sure we have a context to work from and add a comment * Remove unnecessary step from readme * Add footnotes as a feature when using RichTextBlockWithFootnotes * Update changelog * Fix replace_footnote_tags by passing 'value' through and correct features * Footnote make Page and UUID unique together (torchbox#16) * Make Footnotes unique on page-uuid * Add migration * Fix migration and Footnote.DoesNotExist exception * Footnote.DoesNotExist is no longer needed We no longer run .get(), instead we store a list of the page's footnotes, we will get a KeyError if there is an invalid footnote reference. * Bump version to 0.7.0 * Only attempt to add footnotes if the context's 'page' is a Page object * Update wagtail_footnotes/blocks.py Co-authored-by: Dan Braghis <[email protected]> * Cast ``Footnote.uuid`` to string so previews work The keys in ``self.footnotes`` need to be strings in order for lookups to work, but before the ``Footnote`` is saved to the db, it is of type ``UUID``. Refs torchbox#23 * update wagtail 3.0 code changes * update package information * update CHANGELOG * Bump version and update changelog * Fix typo * Modify setup.py so package can be detected by GitHub (torchbox#31) * Bump to version 0.8.0 * Drop Django constraint and let Wagtail dictate it * Adds apps file to specifcy auto field * Add GitHub Action to publish to PyPI on release * Allow wagtail 4 * Alter footnotes admin css selector * Adjust footnotes template to match the new style * Wagtail 2.15,2.16 & 3.0 adjustments They need an alternative template file and javascript file * Fixed typo in template name (torchbox#44) * Revise version to 0.9.0 * Update CHANGELOG.md * Update CHANGELOG.md * Updates to support Wagtail 5 (torchbox#49) * Drop support for Wagtail < 4.1 * Drop support for Python 3.7 * Update pre-commit hooks * Add tests * Add support for Wagtail 5+ * Switch to using ruff * Lint * Remove unused template/JS * Tidy up GitHub Actions * Switch to tox 4 * Test against Wagtail 5.1 (and drop 4.2) * Tidy up coverage configuration * Build and use wheel in CI * Add coverage report in CI * Switch to using PyPI trusted publishing (torchbox#53) * Switch to using flit for package build (torchbox#54) * Drop the docs folder these are draft notes and are not up ready yet * Update the CHANGELOG * Bump version to 0.10.0 * Added basic contributing notes (torchbox#56) Refs torchbox#55 * Add formal Wagtail 5.2 support (torchbox#63) * Add Wagtail 5.2 and Python 3.12 in test matrices, update CHANGELOG.md * Wagtail 5.2 upgrade consideration: Block.get_template now accepts a value argument * Remove instances of Wagtail 5.0 in the test matrix, Update README.md --------- Co-authored-by: Katherine Domingo <[email protected]> * Adapt syntax for Wagtail 4 * Reorder migration --------- Co-authored-by: Cameron Lamb <[email protected]> Co-authored-by: Alex Bridge <[email protected]> Co-authored-by: Dan Braghis <[email protected]> Co-authored-by: John-Scott Atlakson <[email protected]> Co-authored-by: Brian Xu <[email protected]> Co-authored-by: Kevin <[email protected]> Co-authored-by: Kevin <[email protected]> Co-authored-by: Oliver Parker <[email protected]> Co-authored-by: Nick Moreton <[email protected]> Co-authored-by: nick.moreton <[email protected]> Co-authored-by: zerolab <[email protected]> Co-authored-by: Kat <[email protected]> Co-authored-by: Katherine Domingo <[email protected]>
* Cleanup RichTextBlockWithFootnotes (#2) * Cleanup RichTextBlockWithFootnotes * Make sure we have a context to work from and add a comment * Remove unnecessary step from readme * Add footnotes as a feature when using RichTextBlockWithFootnotes * Update changelog * Fix replace_footnote_tags by passing 'value' through and correct features * Footnote make Page and UUID unique together (torchbox#16) * Make Footnotes unique on page-uuid * Add migration * Fix migration and Footnote.DoesNotExist exception * Footnote.DoesNotExist is no longer needed We no longer run .get(), instead we store a list of the page's footnotes, we will get a KeyError if there is an invalid footnote reference. * Bump version to 0.7.0 * Only attempt to add footnotes if the context's 'page' is a Page object * Update wagtail_footnotes/blocks.py Co-authored-by: Dan Braghis <[email protected]> * Cast ``Footnote.uuid`` to string so previews work The keys in ``self.footnotes`` need to be strings in order for lookups to work, but before the ``Footnote`` is saved to the db, it is of type ``UUID``. Refs torchbox#23 * update wagtail 3.0 code changes * update package information * update CHANGELOG * Bump version and update changelog * Fix typo * Modify setup.py so package can be detected by GitHub (torchbox#31) * Bump to version 0.8.0 * Drop Django constraint and let Wagtail dictate it * Adds apps file to specifcy auto field * Add GitHub Action to publish to PyPI on release * Allow wagtail 4 * Alter footnotes admin css selector * Adjust footnotes template to match the new style * Wagtail 2.15,2.16 & 3.0 adjustments They need an alternative template file and javascript file * Fixed typo in template name (torchbox#44) * Revise version to 0.9.0 * Update CHANGELOG.md * Update CHANGELOG.md * Updates to support Wagtail 5 (torchbox#49) * Drop support for Wagtail < 4.1 * Drop support for Python 3.7 * Update pre-commit hooks * Add tests * Add support for Wagtail 5+ * Switch to using ruff * Lint * Remove unused template/JS * Tidy up GitHub Actions * Switch to tox 4 * Test against Wagtail 5.1 (and drop 4.2) * Tidy up coverage configuration * Build and use wheel in CI * Add coverage report in CI * Switch to using PyPI trusted publishing (torchbox#53) * Switch to using flit for package build (torchbox#54) * Drop the docs folder these are draft notes and are not up ready yet * Update the CHANGELOG * Bump version to 0.10.0 * Added basic contributing notes (torchbox#56) Refs torchbox#55 * Add formal Wagtail 5.2 support (torchbox#63) * Add Wagtail 5.2 and Python 3.12 in test matrices, update CHANGELOG.md * Wagtail 5.2 upgrade consideration: Block.get_template now accepts a value argument * Remove instances of Wagtail 5.0 in the test matrix, Update README.md --------- Co-authored-by: Katherine Domingo <[email protected]> * Adapt syntax for Wagtail 4 * Reorder migration --------- Co-authored-by: Cameron Lamb <[email protected]> Co-authored-by: Alex Bridge <[email protected]> Co-authored-by: Dan Braghis <[email protected]> Co-authored-by: John-Scott Atlakson <[email protected]> Co-authored-by: Brian Xu <[email protected]> Co-authored-by: Kevin <[email protected]> Co-authored-by: Kevin <[email protected]> Co-authored-by: Oliver Parker <[email protected]> Co-authored-by: Nick Moreton <[email protected]> Co-authored-by: nick.moreton <[email protected]> Co-authored-by: zerolab <[email protected]> Co-authored-by: Kat <[email protected]> Co-authored-by: Katherine Domingo <[email protected]>
This is basically a copy/paste job from https://github.com/torchbox/wagtailmedia#contributing but with the
interactive
note removed since tox is not currently configured to run interactively.Refs #55