README file support
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 668
- Forks
- 135
- Avg merge
- 4d 19h
- Merged PRs (30d)
- 7
Description
When a user browses a repository, it would be useful if the administrative console displays the content of the README file in the current directory, just like GitHub does with the `README.*` files.
Also, a user may be interested in what a project is for. We need to think about a way to supply a README for a project because we cannot put files into a project. Probably into the `meta` repository?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named. Start by locating the administrative console's repository-browsing entry point and any existing README.* handling, then clarify how project-level README content should be supplied, including the proposed meta repository. Done means directory README content is shown and the project-level README approach is agreed and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, java
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100