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

README && CONTRIBUTING typos, worded phrase, etc #132

Open
maxdevjs opened this issue Oct 8, 2019 · 2 comments
Open

README && CONTRIBUTING typos, worded phrase, etc #132

maxdevjs opened this issue Oct 8, 2019 · 2 comments
Labels
good first issue Good for newcomers

Comments

@maxdevjs
Copy link
Contributor

maxdevjs commented Oct 8, 2019

I am reading through the repo and I would like to ask orientation about a few typos, how phrases are worded, etc.

I list below what I found so far in README && CONTRIBUTING (better to condense this kind of request for several files in an unique eventual issue/PR or each file should be discussed in a separate issue/PR?).

README

  • with contain more of an explanation (not sure how could be rephrased)
  • situatings (situations)
  • Preview Link is broken (Not Found)
  • images that used in templates (images that are used in templates?)
  • git clone https://github.com/[GITHUB_USERNAME]/[REPO_NAME].git could be explained as git clone https://github.com/ml5js/ml5-website?

CONTRIBUTING

  • Since this starter using the (not sure how could be rephrased)
  • starts the gatsby develop server (development?)
  • when you only changing the site (when you are only changing the site?)
  • starts the lambda server in develop mode (development?)
@joeyklee
Copy link
Contributor

joeyklee commented Oct 8, 2019

Hi @maxdevjs - thanks a bunch for looking into this! You've spotted a lot of good points that need to be updated.

I think it is ok to address both files here since they they both document the build/development/contributing process in one way or another.

Thanks!

@maxdevjs
Copy link
Contributor Author

Hi @joeyklee, thank you for your reply. I am still confused about what could be the preferred fix for some things, which I list:

README

  • with contain more of an explanation
    a) that contain more of an explanation
    b) containing more of an explanation
    c) with more of an explanation

  • Preview Link is broken (Not Found)

Should this (broken) link remain in README, deleted, or...?

  • should git clone https://github.com/[GITHUB_USERNAME]/[REPO_NAME].git remain as it is or changed to a self explanatory git clone https://github.com/ml5js/ml5-website?

CONTRIBUTING

  • should Since this starter using the be something like Since this starter uses netlify-lambda?
  • there could be further issues you -> there could be further issues for you?
  • starts the gatsby develop server -> starts the gatsby development server?
  • when you only changing the site -> when you are only changing the site? when you only change the site?
  • starts the lambda server in develop mode -> starts the lambda server in development mode?

@bomanimc bomanimc added the good first issue Good for newcomers label Mar 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants