The README currently contains information for users to get started with their new collection, but this results in a nasty diff when updating the README to contain information about the collection itself.

Moving the information currently in the README to MAINTAINERS would allow users to easily keep the documentation on how to develop and maintain their collection while also giving developers a better starting point for their own READMEs.

To match
PrefectHQ/prefect-aws#110

We're recommending that maintainers of collections configure code owners for their collection. We can make that easier by adding a blank CODEOWNERS file to the template. Here's documentation for creating a CODEOWNERS file: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

Things don't seem to be clickable in dark mode:

Similar to:
PrefectHQ/prefect#7462

There's a v0.4.0 version available:
PrefectHQ/prefect#7451

Add configuration for CodeQL code scanning to the template os that collections can be set up with CodeQL code scanning out of the box.

Here's the documentation for setting up CodeQL code scanning: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-actions

Similar to:
PrefectHQ/prefect#7304

To ensure that the pipeline doesn't break during release.

I think it would be worthwhile to add some more detail to the Writing Documentation section. A quick blurb about how to create a new file for a module and what to put in the file to automatically pull in the documentation for that module along with how to add navigation for that new page should suffice.

Dependabot has submitting PRs to update some of the GitHub actions in our collection repos. We can make the following updates to the GitHub Actions workflows in the template:

• Bump actions/setup-python from 2 to 3
• Bump actions/checkout from 2 to 3
• Bump JamesIves/github-pages-deploy-action from 4.2.3 to 4.2.5

When community members generate a collection from our template, they get our 'Template Synchronization' and 'Add issues to integrations board' workflows. Those workflows will fail if the corresponding secrets are not configured. We should avoid cluttering the actions logs of repos that don't want or need these workflows. We should consider making those workflows opt-in during collection creation and/or skipping execution of those workflows if the needed secrets are not configured.

I like the idea of having a template for creating the collections. As more and more python projects are moving to pyproject.toml, I'm wondering why not use that new project format for the template?

This would allow:

• use more modern tools
• have all the configurations in one file
• better support for dependencies
• Enable lock file support

At minimum like read MAINTAINERS.md

With the mkdocs-gen-files plugin, we can automatically generate the index page of the docs for a collection by copying the README. This means that we won't have make changes in duplicate when updating documentation.

There's a reference implementation in prefect-slack here: PrefectHQ/prefect-slack@327a7ba

A Linter for performance anti-patterns: https://github.com/tonybaloney/perflint

To auto-remove imports

So we don't have to manually format the strings, like: https://github.com/PrefectHQ/prefect/pull/8578/files

Like https://app.codecov.io/gh/pangeo-data/climpred

Covers like tests are passing, coverage percentage, etc.

Or does interrogate do that already?

Orion includes 3.10 support

From
https://github.com/PrefectHQ/prefect/pull/8224/files

coveralls
codecov
coverage

Making prefect-managed collections available via the conda-forge channel could help improve the accessibility of prefect collections for conda users.

Since there is a submission / listing process independent of PyPI's, we'd probably want to design and implement some CI/CD that would take care of providing a valid package recipe to the conda forge reviewers and kicking off that review process.

More info on contributing packages to the conda-forge channel

This can standardize our docstrings, e.g. missing periods.
https://www.pydocstyle.org/en/stable/usage.html#in-file-configuration

To implement, add to pre-commit + static analysis
https://www.pydocstyle.org/en/stable/usage.html#example

[pydocstyle]
inherit = false
ignore = D100,D203,D405
match = .*\.py

-   repo: https://github.com/pycqa/pydocstyle
    rev: 6.1.1  # pick a git hash / tag to point to
    hooks:
    -   id: pydocstyle

See https://github.com/PrefectHQ/prefect/tree/main/.github/ISSUE_TEMPLATE for inspiration. Maybe a much simpler one?

In our main docs we have an easy link to GH in the top navbar

It'd be nice to include the same widget in collections

Hello,
I developing on prefect project and I want give new name for collection and slug names. But I've got an error when I was get install command. How can I set new name?

import re
import sys


MODULE_REGEX = r"^[_a-zA-Z][_a-zA-Z0-9]+$"
PREFECT_COLLECTION_MODULE_REGEX = r"^prefect_[_a-zA-Z][_a-zA-Z0-9]+$"
PREFECT_COLLECTION_NAME_REGEX = r"^prefect-[-a-zA-Z][-a-zA-Z0-9]+$"

collection_slug = "my_collection"
collection_name = "my-collection"

if not re.match(MODULE_REGEX, collection_slug):
    print(
        f"ERROR: The collection slug ({collection_slug}) is not a valid Python module name. "
        "Please do not use - and use _ instead"
    )
    sys.exit(1)

if not re.match(PREFECT_COLLECTION_MODULE_REGEX, collection_slug):
    print(
        f"ERROR: The collection slug ({collection_slug}) is not a valid Prefect collection module name. "
        "Please ensure your collection slug is prefixed with 'prefect_'"
    )

https://interrogate.readthedocs.io/en/latest/