react-email icon indicating copy to clipboard operation
react-email copied to clipboard

Published 20 hours ago • verified publisher icon resendlabs

feat(docs): Improved contributing guide

Open gabrielmfern opened this issue 1 year ago • 4 comments

This new contributing guide includes a lot of changes and a lot of additions. First it changes the CONTRIBUTING.md to be a pointer into the contributing guide in the docs because of its new size and level of detail.

Secondly, instead of having one page for the contributing guide, there's a new section for it with its pieces inside.

screenshot for how the contributing section looks like in the sidebar

The new contributing guide includes two extra things that I've found are helpful, that other projects include it themselves:

  1. A codebase overview
    • Mentioning how we do things, what tools we use and how our files are structured
  2. A step-by-step of the development workflow,

As for the two sections that we had before for Opening issues and Opening pull requests, they are now pages in the docs. To them, I've also added things that I think are really important, that might guide people coming across it to do better work.

Opening issues section
Codebase overview section
Opening pull requests section

gabrielmfern avatar Mar 05 '24 13:03 gabrielmfern

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
react-email ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 29, 2024 3:37pm
react-email-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 29, 2024 3:37pm

vercel[bot] avatar Mar 05 '24 13:03 vercel[bot]

The staging deploy also worked out, if anyone wants to check it out https://react-email-feat-improved-contributing-guide.mintlify.app/contributing/opening-issues.

gabrielmfern avatar Mar 05 '24 14:03 gabrielmfern

The staging deployment looks great, especially for first time contributors (like myself). Is there a plan for when this will go live?

PCRinus avatar Aug 25 '24 16:08 PCRinus

⚠️ No Changeset found

Latest commit: c635025adfc665805d9707cfc61c018b96c6ac5f

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

changeset-bot[bot] avatar Aug 29 '24 15:08 changeset-bot[bot]