creativecommons / creativecommons/search

[Improvement] Add projects description, problems and expected outcome in `README.md` documentation

Open
#161 9 comments 0 reactions 0 assignees View on GitHub
✨ goal: improvement 💬 talk: discussion 💻 aspect: code 🟩 priority: low 🧹 status: ticket work required
Dominant language
CSS
Stars
27
Forks
112
PR merge metrics
No merged PRs in 30d

Description

## 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.