creativecommons
[Improvement] Add projects description, problems and expected outcome in `README.md` documentation
Problem
There is only documentation about setting up the project in the Projects README, although that may not neccessarily be a problem. We can work on ways to improve the README
Description
By adding a detailed description of the project, the problems associated with the project and the expected outcome just as on the outreachy website I believe the project will be more complete. if this issue is approved Would like to work with a mentor to add additional description if needed.
Additional context
Implementing this would make it that just by reading the README.md documentation you would be able to understsand the details and complete direction of the project.
Implementation
- [x] I would be interested in implementing this feature.
@FrancoFrancis I'd be interested to see what suggestions anyone would have here on what should be appended to the README.md file to improve things.
@FrancoFrancis I'd be interested to see what suggestions anyone would have here on what should be appended to the
README.mdfile to improve things.
Okay, Can I go on to the community to start an open discussion ? :)
@FrancoFrancis You can direct them here to have the discussion so the record is on this Issue, but sure, please do! ❤️
@FrancoFrancis You can direct them here to have the discussion so the record is on this Issue, but sure, please do! ❤️
okay on it.
@possumbilities @FrancoFrancis.... I think the most important part is a documentation that talks about the functionality and what the project does in the README
@FrancoFrancis correct me if I'm wrong. Do you mean the readme of the project should include problems that are expected to be resolved within the project? For example "We're looking to refactor the code base, etc" Something like that?
@FrancoFrancis correct me if I'm wrong. Do you mean the readme of the project should include problems that are expected to be resolved within the project? For example "We're looking to refactor the code base, etc" Something like that?
Yes.... the issue is open for discussion on what should be appended to the README.md to make it as informative as possible this is to make sure getting started as a user or as a developer/contributor is as easy as possible and also to reduce noice, because it is the one of the most important parts of any Github project.
Hi @possumbilities can I proceed to working on this issue while its still open for discursion?