Skip to content

Conversation

@mcmire
Copy link
Contributor

@mcmire mcmire commented Nov 30, 2022

The monorepo works differently than other repos, and we want to make sure that contributors are able to use it on their own:

  • The release process is different than other repos because it makes use of create-release-branch rather than the create-release-pr action.
  • Performing tasks (running tests, etc.) across the monorepo is different than with other repos because it takes advantage of workspaces.
  • Testing changes made to the monorepo in other projects is different because of the use of preview builds.

This commit moves the existing contributor documentation which was formerly present in the README to a separate file and adds some more sections.

The monorepo works differently than other repos, and we want to make
sure that contributors are able to use it on their own:

* The release process is different than other repos because it makes use
  of `create-release-branch` rather than the `create-release-pr` action.
* Performing tasks (running tests, etc.) across the monorepo is
  different than with other repos because it takes advantage of
  workspaces.
* Testing changes made to the monorepo in other projects is different
  because of the use of preview builds.

This commit moves the existing contributor documentation which was
formerly present in the README to a separate file and adds some more
sections.
@mcmire mcmire requested a review from a team as a code owner November 30, 2022 17:45
@mcmire mcmire mentioned this pull request Nov 30, 2022
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
Copy link
Member

@Gudahtt Gudahtt left a comment

Choose a reason for hiding this comment

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

LGTM, great work!

@mcmire mcmire merged commit 8e5039a into main Dec 1, 2022
@mcmire mcmire deleted the more-concise-docs branch December 1, 2022 22:35
gantunesr pushed a commit that referenced this pull request Dec 8, 2022
The monorepo works differently than other repos, and we want to make
sure that contributors are able to use it on their own:

* The release process is different than other repos because it makes use
of `create-release-branch` rather than the `create-release-pr` action.
* Performing tasks (running tests, etc.) across the monorepo is
different than with other repos because it takes advantage of
workspaces.
* Testing changes made to the monorepo in other projects is different
because of the use of preview builds.

This commit moves the existing contributor documentation which was
formerly present in the README to a separate file and adds some more
sections.

Co-authored-by: Maarten Zuidhoorn <maarten@zuidhoorn.com>
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
MajorLift pushed a commit that referenced this pull request Oct 11, 2023
The monorepo works differently than other repos, and we want to make
sure that contributors are able to use it on their own:

* The release process is different than other repos because it makes use
of `create-release-branch` rather than the `create-release-pr` action.
* Performing tasks (running tests, etc.) across the monorepo is
different than with other repos because it takes advantage of
workspaces.
* Testing changes made to the monorepo in other projects is different
because of the use of preview builds.

This commit moves the existing contributor documentation which was
formerly present in the README to a separate file and adds some more
sections.

Co-authored-by: Maarten Zuidhoorn <maarten@zuidhoorn.com>
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
MajorLift pushed a commit that referenced this pull request Oct 11, 2023
The monorepo works differently than other repos, and we want to make
sure that contributors are able to use it on their own:

* The release process is different than other repos because it makes use
of `create-release-branch` rather than the `create-release-pr` action.
* Performing tasks (running tests, etc.) across the monorepo is
different than with other repos because it takes advantage of
workspaces.
* Testing changes made to the monorepo in other projects is different
because of the use of preview builds.

This commit moves the existing contributor documentation which was
formerly present in the README to a separate file and adds some more
sections.

Co-authored-by: Maarten Zuidhoorn <maarten@zuidhoorn.com>
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
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.

5 participants