Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] update on project setup in ReadME.md #308

Closed
1 task done
dikehprosper opened this issue Oct 14, 2022 · 7 comments
Closed
1 task done

[Feature] update on project setup in ReadME.md #308

dikehprosper opened this issue Oct 14, 2022 · 7 comments
Assignees
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🚧 status: blocked Blocked & therefore, not ready for work

Comments

@dikehprosper
Copy link

dikehprosper commented Oct 14, 2022

Problem

read.MD does not contain proper directions on data cloning to the local repository
Screenshot 2022-10-14 122359

Description

this has affected many people that don't have the knowledge of cloning to a local directory

Alternatives

see a better illustration of data repository cloning from the meta-search repository
first setup

second setup

setting up an instructive direction would help a lot of new users

Additional context

Implementation

  • I would be interested in implementing this feature.
@dikehprosper dikehprosper added ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🟩 priority: low Low priority and doesn't need to be rushed labels Oct 14, 2022
@dikehprosper
Copy link
Author

@possumbilities @TimidRobot please triage this issue

@dikehprosper dikehprosper changed the title [Feature] update on ReadME.md [Feature] update on project setup in ReadME.md Oct 14, 2022
@ImaJin14
Copy link
Contributor

This isn't necessary cuz interns are ore required to have had information on git.... And cloning is in the GitHub tutorials as you just create an account...

@ImaJin14
Copy link
Contributor

@TimidRobot can throw more light on it

@TimidRobot TimidRobot added 🚧 status: blocked Blocked & therefore, not ready for work 📄 aspect: text Concerns the textual material in the repository 🤖 aspect: dx Concerns developers' experience with the codebase and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 💻 aspect: code Concerns the software code in the repository labels Oct 17, 2022
@TimidRobot
Copy link
Member

This issue raises a valid concern: this repository/project assumes some skills and anyone without them is not helped.

  • We will be working to better document/communicate those assumptions.
  • We will also be working to improve our introductory documentation (but I expect it will be referenced--not added to this repository).

I'm going to leave this issue open (but blocked) until progress has been made.

@ImaJin14
Copy link
Contributor

ImaJin14 commented Oct 19, 2022

@TimidRobot @possumbilities I think I covered this issue in my last PR #312 though it was more of a link and not detailed instructions at once

@ImaJin14
Copy link
Contributor

@TimidRobot @possumbilities I think I covered this issue in my last PR #312 though it was more of a link and not detailed instructions at once

@TimidRobot I think I resolve this his issue about cloning a repository in my last PR that was merged....

@TimidRobot TimidRobot assigned TimidRobot and ImaJin14 and unassigned TimidRobot Oct 24, 2022
@TimidRobot
Copy link
Member

TimidRobot commented Oct 24, 2022

This issue raises a valid concern: this repository/project assumes some skills and anyone without them is not helped.

  • We will be working to better document/communicate those assumptions.
  • We will also be working to improve our introductory documentation (but I expect it will be referenced--not added to this repository).

I'm going to leave this issue open (but blocked) until progress has been made.

Also see:

@possumbilities possumbilities self-assigned this Oct 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🚧 status: blocked Blocked & therefore, not ready for work
Projects
None yet
Development

No branches or pull requests

4 participants