8000 Add repo-specific CONTRIBUTING.md by MaoShizhong · Pull Request #518 · TheOdinProject/javascript-exercises · GitHub
[go: up one dir, main page]
Skip to content

Add repo-specific CONTRIBUTING.md #518

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Feb 11, 2025
Merged

Add repo-specific CONTRIBUTING.md #518

merged 6 commits into from
Feb 11, 2025

Conversation

MaoShizhong
Copy link
Contributor
@MaoShizhong MaoShizhong commented Jan 29, 2025 •
edited
Loading

Because

Most of our other repos have their own specific CONTRIBUTING.md that extends the general contributing guide.

A surprisingly not-that-uncommon thing I've seen in the community is learners starting these exercises for the first time, following the installation instructions, but then also doing the "Adding New Exercises" instructions at the bottom of the README, even if they're not actually adding any new exercises.

It would make sense to extract that section to a separate contributing guide for this repo, which will keep the README focused on the instructions for installing things and using the exercises, eliminating any accidental npm run generates and all the joy that comes with ensuing confusion.

This PR

  • Writes repo-specific contributing guide.
  • Removes "Adding New Exercises" instructions from README.md.
  • Changes link to general contributing guide in README.md to point to the repo-specific one (which will open with a link to the general guide, as with other repo-specific guides).

Issue

Closes #XXXXX

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. 01_helloWorld: Update test cases
  • 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 this PR includes any changes that affect the solution of an exercise, I've also updated the solution in the /solutions folder

JoshDevHub
JoshDevHub requested changes Feb 11, 2025
View reviewed changes
Copy link
Contributor
@JoshDevHub JoshDevHub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Outside of one alignment nit this seems good to go 👍

@JoshDevHub JoshDevHub merged commit 59b5fc7 into TheOdinProject:main Feb 11, 2025
@MaoShizhong MaoShizhong deleted the contributing-md branch February 11, 2025 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JoshDevHub JoshDevHub JoshDevHub approved these changes

@thatblindgeye thatblindgeye Awaiting requested review from thatblindgeye

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@MaoShizhong @JoshDevHub
0