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

React: Complete README #26413

Closed
wants to merge 1 commit into from
Closed

React: Complete README #26413

wants to merge 1 commit into from

Conversation

scorpi4n
Copy link
Contributor

@scorpi4n scorpi4n commented Oct 4, 2023

Because

The README in the react folder was mostly blank (only had "wip") whereas the other folders had complete READMEs.

This PR

  • Completes the react folder's README in the same way the other folders' READMEs are

Issue

The contributing guide said small changes can have a PR submitted without opening an issue

Additional Information

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

@github-actions github-actions bot added the Content: React Involves the React course label Oct 4, 2023
@ManonLef
Copy link
Member

ManonLef commented Oct 4, 2023

Thank you for doing this! I do wish to discuss this with @TheOdinProject/maintainers

With the ever changing content, I wonder if these are a good idea to keep around in their current form to be honest. A bunch of new lessons were added recently and I'm sure the README's haven't been updated.

Perhaps we can consider a better format for the README's which doesn't include the path layout and is less coupled. Instead we could consider a contributing guide, a contact method for professionals or content creators or something like that? I would love to hear opinions.

@scorpi4n
Copy link
Contributor Author

scorpi4n commented Oct 4, 2023

I was kind of wondering the same while I put it together. I was doing the 'Using Git In The Real World' lesson and found the blank README, so I figured I might as well create a PR.

I do think it'd be a good idea to either entirely rewrite or just remove the README's. All of them have a disclaimer saying that they might be out of sync with the actual courses, and the README I put together hadn't been touched in about a year.

@thatblindgeye
Copy link
Contributor

I feel like we could get away with just removing them. I can't think of anything that should live in individual directory README's that isn't better suited to the top level README/contribution guide, other than possibly a basic overview of what the course is/should ideally cover (though is that really necessary?).

@01zulfi
Copy link
Member

01zulfi commented Oct 6, 2023

The current layout of course README's was part of the folder structure project I was working on last year. See TheOdinProject/top-meta#109

+1 on removing the course READMEs. They are out -of-date and provide little to no value.

@scorpi4n
Copy link
Contributor Author

scorpi4n commented Oct 6, 2023

Removing the READMEs is simple enough, I can do that if that's how we want to move forward.

@01zulfi
Copy link
Member

01zulfi commented Oct 7, 2023

@scorpi4n Yes, please make a PR if you can

@scorpi4n
Copy link
Contributor Author

scorpi4n commented Oct 7, 2023

Alright! I'll close those this one and work make a new PR

@scorpi4n scorpi4n closed this Oct 7, 2023
@ManonLef ManonLef mentioned this pull request Oct 7, 2023
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content: React Involves the React course
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants