Skip to content

Readme: enforce and check a README file (either .md or .rst) #16

@andreoliwa

Description

@andreoliwa

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

No one assigned

    Labels

    Projects

    Status

    Ideas

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions