jazzband / jazzband/help

Best practices / standards: Workgroup + sprints?

Open
#314 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
28
Forks
6
PR merge metrics
No merged PRs in 30d

Description

There are areas that could be covered are infra / devops / even bikesheddy when taken alone - but at scale, very concrete; best practices:

- test framework:
- pytest vs unittest, either?
- require tests to merge?
- doctests?
- CI
- [tox-gh-actions](https://pypi.org/project/tox-gh-actions/)
- github templates:
- bug report template? issue template?
- Whether or not to add `.python-version` ([pyenv](https://github.com/pyenv/pyenv)), `.tool-versions` ([asdf](https://asdf-vm.com/))
- documentation:
- [furo](https://github.com/pradyunsg/furo) by @pradyunsg
- jazzband projects could perhaps have a furo theme w/ jazzband colors?
- general structure
- e.g. PyPA's doc structure with pip and furo are laid out very nicely
- language support? e.g. /en/
- version support? e.g. /v1.2.0/
- changelog template?
- README template structure
- Things that are PR'able via @jazzband-bot, vs things that may need a sprint across projects to do by hand
- Anything else?

Are any of these worth taking up in an independent issue here? Somewhere else? Worth discussing in whole?

Is it worth having an "exemplar" or "flagship" jazzband python project with the latest best practices that others can imitate?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.