What needs to be done:
There needs to be a short summary of what the pipeline does, in the top of the README file.
Suggestions on how to get it done:
Someone involved in the project writes a few lines about it, in the top of the README.md file.
What are the arguments for getting it done:
As a newcomer, it is not at all clear to me what it does, and thus, it will likely be unclear to most other users not already involved in the project as well. :)
Task is considered finished when:
A user not involved with a project can read the README-file, understand and explain in their own words what the pipeline does.
What needs to be done:
There needs to be a short summary of what the pipeline does, in the top of the README file.
Suggestions on how to get it done:
Someone involved in the project writes a few lines about it, in the top of the
README.mdfile.What are the arguments for getting it done:
As a newcomer, it is not at all clear to me what it does, and thus, it will likely be unclear to most other users not already involved in the project as well. :)
Task is considered finished when:
A user not involved with a project can read the README-file, understand and explain in their own words what the pipeline does.