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

REAMDE.rst could need some love #12

Open
4 tasks
sbuerk opened this issue Nov 20, 2022 · 0 comments
Open
4 tasks

REAMDE.rst could need some love #12

sbuerk opened this issue Nov 20, 2022 · 0 comments

Comments

@sbuerk
Copy link
Contributor

sbuerk commented Nov 20, 2022

A README.md, REAMDE.rst or similar is the first
place contributors would look into for some kind of
intstruction on how to contribute workflow is is or
how to execute the several tools.

For that, maybe we should donate some love to the
README.rst for:

  • explain what this package is for/what it does
  • explain shortly prefered contribution steps
  • explain Build/Scripts/runTests.sh for CI and local usage
  • add build badge(s) from the job executions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant