Skip to content

[docs] reorganize contributors guide#3029

Merged
benmccann merged 1 commit intomasterfrom
contrib
Dec 14, 2021
Merged

[docs] reorganize contributors guide#3029
benmccann merged 1 commit intomasterfrom
contrib

Conversation

@benmccann
Copy link
Member

Moves things around a bit, so it flows a bit better. See the rendered version here: https://github.com/sveltejs/kit/blob/contrib/README.md

Some changes:

  • We had two "Documentation" headings, so you couldn't link to that section
  • Put "Code structure" under "Developing"
  • Moved "Releases" out of "Developing"
  • Made a new heading for "Working on Vite and other dependencies" since it's not necessarily related to running the tests
  • Made a new section for project-specific stuff related to sending PRs

@changeset-bot
Copy link

changeset-bot bot commented Dec 12, 2021

⚠️ No Changeset found

Latest commit: 807896b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Member

@bluwy bluwy left a comment

Choose a reason for hiding this comment

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

LGTM. Maybe it's worth extracting this into a CONTRIBUTING.md file, but having in the readme is fine by me as well.

@benmccann
Copy link
Member Author

yeah, fair question. for now, I'll leave that for another day

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants