-
-
Notifications
You must be signed in to change notification settings - Fork 23
Open
Labels
enhancementNew feature or requestNew feature or requestplugin-textPlugin for text filesPlugin for text files
Description
Expected Behavior
Any Python project should always have a README.md
or README.rst
file.
And they might need certain content in it.
If the style file contains values for both files, raise a flake8 error as well ("Your style file contains rules for README.md and README.rst. Use only one of them").
Current Behavior
Those files don't have a file checker for their content.
Possible Solution
# Create parent classes to set the precedent to check even other .rst or .md files
class MarkdownFile(BaseFile):
pass
class RestructuredTextFile(BaseFile):
pass
class ReadmeMd(MarkdownFile):
pass
class ReadmeRst(RestructuredTextFile):
pass
Context
Real world examples:
- The readme should have a PyPI and a Travis CI badge for a library project;
- All Python projects should have a black badge.
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestplugin-textPlugin for text filesPlugin for text files
Projects
Status
Ideas