Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend README.md #32

Closed
Ryuno-Ki opened this issue Oct 8, 2020 · 0 comments
Closed

Extend README.md #32

Ryuno-Ki opened this issue Oct 8, 2020 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@Ryuno-Ki
Copy link
Contributor

Ryuno-Ki commented Oct 8, 2020

Is your feature request related to a problem? Please describe.
This is a follow-up of #7 (comment)
It shall help contributors and users get up-to-speed with this project.

Describe the solution you'd like
A good README should contain the following items (IMHO)

  1. The name of the project (Personally, I put badges behind this line, i.e. build status or code coverage)
  2. A sentence of what it does. What problem does it solve? Perhaps at a GIF showing of it
  3. A single line of how to get a local installation running (virtualenv + clone + execution)
  4. How to execute tests (still missing here, e.g. tox or py.test)
  5. How to contribute (with a link to CONTRIBUTING.md)
  6. License (with a link to LICENSE.txt)

Describe alternatives you've considered
From experience, I already learned myself how to setup most Python projects. You could make people research on their own.
But they will likely go looking elsewhere for a project instead of investing time …

Additional context
You can read up more on pages like

@SethWalkeroo SethWalkeroo added enhancement New feature or request good first issue Good for newcomers Hacktoberfest and removed Hacktoberfest good first issue Good for newcomers labels Oct 8, 2020
@SethWalkeroo SethWalkeroo self-assigned this Oct 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants