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

docs: Updates contributing file #2112

Merged
merged 7 commits into from
Nov 21, 2023
Merged

Conversation

hellofanny
Copy link
Contributor

@hellofanny hellofanny commented Nov 17, 2023

What's the purpose of this pull request?

The contributing file it was outdated. This PR attempts to update this file with up-to-date instructions to help contributors.

Should we add a page on https://www.faststore.dev/docs with this guide?

Copy link

vercel bot commented Nov 17, 2023

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

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
faststore-site ⬜️ Ignored (Inspect) Visit Preview Nov 21, 2023 2:56pm

Copy link

codesandbox-ci bot commented Nov 17, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 7527986:

Sandbox Source
Store UI Typescript Configuration

@hellofanny hellofanny changed the title Docs/updates contributing file docs: Updates contributing file Nov 17, 2023
@hellofanny hellofanny self-assigned this Nov 17, 2023
@hellofanny hellofanny added the documentation Improvements or additions to documentation label Nov 17, 2023
@hellofanny hellofanny marked this pull request as ready for review November 17, 2023 15:15
@hellofanny hellofanny requested a review from a team as a code owner November 17, 2023 15:15
@hellofanny hellofanny requested review from icazevedo, ArthurTriis1, mariana-caetano, a team and emersonlaurentino and removed request for a team and ArthurTriis1 November 17, 2023 15:15
CONTRIBUTING.MD Outdated Show resolved Hide resolved
CONTRIBUTING.MD Outdated
Comment on lines 18 to 19
3. Run `yarn dev` at each of the packages that depends on the other.
> You can run a package individually: `yarn workspace {packageName} dev`
Copy link
Member

Choose a reason for hiding this comment

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

We're using turborepo, so we need to encourage the people to use it too.

Here is an example:

yarn turbo run dev:server --filter=@faststore/api

CONTRIBUTING.MD Outdated Show resolved Hide resolved
CONTRIBUTING.MD Outdated Show resolved Hide resolved
@hellofanny hellofanny merged commit 00b722b into main Nov 21, 2023
@hellofanny hellofanny deleted the docs/updates-contributing-file branch November 21, 2023 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants