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

🚨 PRIORITY: Lockfile conflict 🚨 #10

Merged
merged 3 commits into from
Oct 10, 2021
Merged

🚨 PRIORITY: Lockfile conflict 🚨 #10

merged 3 commits into from
Oct 10, 2021

Conversation

meg-gutshall
Copy link
Member

Description

LOCKFILE FIX

🚨 This needs to be merged immediately and everyone has to delete their current forks/clones and refork them! 🚨

You can't have both a package-lock.json file and a yarn.lock file in the same repository. Ever. Super bad!

Conflicting lockfiles

Although npm and Yarn are both JavaScript package managers, their respective lockfiles pull from different sources (npm and yarn respectively) and therefore can get out of sync. The project needs to pick one source and stick to it so that everyone will have the same exact version of every required package.

I adjusted the README to reflect the use of npm only because installing Yarn requires an extra step.

README Changes

I linted the entire README file's markdown and reworded some lines for clarity/conciseness.

I copied the issue on the Hacktoberfest repo to this project's Wiki in an effort to consolidate information. I also linted the markdown for that.

I converted that CONTRIBUTING.md link into a relative link. It's a handy shortcut you should check out!
If you want to do a deep dive, see GFM (GitHub Flavored Markdown).

Under the "Getting Started" directions, I made the change stated above and also added in a step for installing Node.js if the contributor doesn't have it already. Right now that step is just an empty link. I'm going to create an issue to add this to the Wiki and link it back. I'll finish it up later if no one claims it.

I also added a "More Commands" section that displays the basic scripts that come built into the Next.js application which I found in the documentation that was linked. Thank you! 😁

Type of change

Please delete options that are not relevant.

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (refactored or beautified code without changing functionality)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I have tested my feature, bug fix, etc.

@vercel
Copy link

vercel bot commented Oct 10, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/self-taught-software-developers/stsd-restaurant-menu-viewer/3u6H36utwcTDMDqc2ntRKnvEdprd
✅ Preview: https://stsd-restaurant-menu-git-98f27f-self-taught-software-developers.vercel.app

@meg-gutshall meg-gutshall self-assigned this Oct 10, 2021
@meg-gutshall meg-gutshall added bug Something isn't working documentation Improvements or additions to documentation labels Oct 10, 2021
@jamesmerk
Copy link
Contributor

Thanks for the suggestions and updates Meg!

@jamesmerk jamesmerk merged commit e0acf0c into self-taught-software-developers:main Oct 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants