This is part of an effort to make the Kivy sibling projects' documentation
structure consistent and up-to-date.
CHECKLIST
CONTRIBUTING.md
[x If repo takes user contributions, is present
[x] In root dir (not .github dir)
[x] Explains relationship to Kivy, if unclear.
[x] Refers to kivy/kivy Contribution Guidelines.
LICENSE
[x] If repo takes user contributions, is present.
[x] Acknowledges the range of years to 2023.
[x] Acknowledges Kivy Team and other contributors
[x] Mentions it is an MIT License.
CODE_OF_CONDUCT.md
[x] If repo takes user contributions or hosts discussions, is present.
[x] Refers to kivy/kivy CODE_OF_CONDUCT.md
CONTACT.md
[x] Refers to kivy/kivy CONTACT.md
FAQ.md
[NA] If repo is big enough for RST documentation, is present.
README:
[x] Is a Markdown file.
[x] Describes the project.
[x] Describes its place in the Kivy sibling projects.
[NA] If Documentation exists, mention it.
[x] If CONTRIBUTING exists, mentions it.
[x] If LICENSE exists, mentions it.
[x] If CODE_OF_CONDUCT exists, mentions it.
[x] Mentions kivy/kivy CONTACT.md
[x] Uses Python syntax colouring for embedded Python code.
[] Uses badges to display current status, including:
[x] Backers
[x] Sponsors
[x] GitHub contributors
[x] Contributor Covenant
[x] PyPI Version
[x] PyPI Python Version
[x] Build/Test status
[x] Displays all contributors to the repo.
[x] Displays backers
[x] Displays top sponsors.
RST documentation, if present
[NA] Describes the project.
[NA] Describes its place in the Kivy sibling projects.
[NA] Mentions (Kivy/Kivy) Contact Us link.
[NA] Mentions LICENSE.
[NA] Mentions CONTRIBUTING
[NA] Mentions FAQ
[NA] conf.py mentioned Kivy Team and other contributors
WORKFLOWS
[NA] NO_RESPONSE.yml is present if the repo has awaiting_reply tag.
[NA] NO_RESPONSE uses latest script versions.
[NA] NO_RESPONSE runs every day, and skips if forked.
[NA] SUPPORT.yml is present if the repo has a support tag.
[NA] SUPPORT.yml refers to repo's CONTACT.md
setup.py/cfg, if present and on PyPI
[x] Supplies description to PyPI
[x] Supplies Python versions to PyPI
[NA] Supplies Documentation, if any, to PyPI
This is part of an effort to make the Kivy sibling projects' documentation structure consistent and up-to-date.
CHECKLIST
CONTRIBUTING.md [x If repo takes user contributions, is present [x] In root dir (not .github dir) [x] Explains relationship to Kivy, if unclear. [x] Refers to kivy/kivy Contribution Guidelines.
LICENSE [x] If repo takes user contributions, is present. [x] Acknowledges the range of years to 2023. [x] Acknowledges Kivy Team and other contributors [x] Mentions it is an MIT License.
CODE_OF_CONDUCT.md [x] If repo takes user contributions or hosts discussions, is present. [x] Refers to kivy/kivy CODE_OF_CONDUCT.md
CONTACT.md [x] Refers to kivy/kivy CONTACT.md
FAQ.md [NA] If repo is big enough for RST documentation, is present.
README: [x] Is a Markdown file. [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [NA] If Documentation exists, mention it. [x] If CONTRIBUTING exists, mentions it. [x] If LICENSE exists, mentions it. [x] If CODE_OF_CONDUCT exists, mentions it. [x] Mentions kivy/kivy CONTACT.md [x] Uses Python syntax colouring for embedded Python code. [] Uses badges to display current status, including: [x] Backers [x] Sponsors [x] GitHub contributors [x] Contributor Covenant [x] PyPI Version [x] PyPI Python Version [x] Build/Test status
[x] Displays all contributors to the repo.
[x] Displays backers [x] Displays top sponsors.
RST documentation, if present [NA] Describes the project. [NA] Describes its place in the Kivy sibling projects. [NA] Mentions (Kivy/Kivy) Contact Us link. [NA] Mentions LICENSE. [NA] Mentions CONTRIBUTING [NA] Mentions FAQ [NA] conf.py mentioned Kivy Team and other contributors
WORKFLOWS [NA] NO_RESPONSE.yml is present if the repo has awaiting_reply tag. [NA] NO_RESPONSE uses latest script versions. [NA] NO_RESPONSE runs every day, and skips if forked. [NA] SUPPORT.yml is present if the repo has a
supporttag. [NA] SUPPORT.yml refers to repo's CONTACT.mdsetup.py/cfg, if present and on PyPI [x] Supplies description to PyPI [x] Supplies Python versions to PyPI [NA] Supplies Documentation, if any, to PyPI