creativecommons / creativecommons/search

[Feature] Improvements on repo Readme.md

Open
#63 33 comments 1 reaction 0 assignees View on GitHub
✨ goal: improvement 💻 aspect: code 🚧 status: blocked 🟩 priority: low
Dominant language
CSS
Stars
27
Forks
112
PR merge metrics
No merged PRs in 30d

Description

## Problem

As a beginner and new contributor to the Creative Commons Community, I made some mistakes while trying to install docker and clone the repo.
After reading through the Readme.md, I took the first step under 'Docker compose setup' in the Readme.md and clicked on the link to install Docker. And then I had several failed attempts in starting up Docker.

After successfully setting up Docker, I made a mistake by attempting to clone the repo in Docker, because I did not properly understand the second instruction. Cloning the repo in Docker took so many hours and my PC even lagged behind for a bit.

## Description

In this context, I suggest we add more descriptive guidelines in the Readme.md, by adding a few sides notes that state the main tools needed for the project and their uses.
For instance; stating that Docker is just for background work and the code editor/IDE is where the cloning and main work should be done.
This way, new contributors who are most likely beginners will be able to understand the steps and process better and avoid making mistakes.

## Implementation

- [x] I would be interested and happy to implement this feature.
-Under the 'Setting Up the Project' section, it will be nice to include:
The three main tools you'll need on most projects here are:

Docker App (Docker does some heavy lifting, but it's mostly for background use)
A code editor/IDE (VS Code, Sublime, Nova, etc.)(This is where the bulk of the work, like cloning your repo, and making your code changes, will be done)
A command-line/terminal client (Terminal, iTerm2, etc.) (if your IDE doesn't have one)
If you have all three of these tools, then you can proceed to the next steps below

Under Docker Setup, I feel like a more detailed step by step instructions should be added.

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.