[Docs] Add CONTRIBUTING.md #2408
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
smnandre
reviewed
Nov 27, 2024
smnandre
reviewed
Nov 27, 2024
smnandre
reviewed
Nov 27, 2024
smnandre
reviewed
Nov 27, 2024
smnandre
reviewed
Nov 27, 2024
CONTRIBUTING.md
Outdated
Comment on lines
79
to
85
| To help you with assets, we provide the following commands that can be run at the root of the repository or in each package directory: | ||
| - `yarn run build`: build (compile) assets, | ||
| - `yarn run test`: run the tests (through Vitest), | ||
| - `yarn run lint`: lint assets (through Biome.js), | ||
| - `yarn run format`: format assets (through Biome.js), | ||
| - `yarn run check-lint`: check assets linting (through Biome.js), | ||
| - `yarn run check-format`: check assets formatting (through Biome.js) |
There was a problem hiding this comment.
Suggested change
| To help you with assets, we provide the following commands that can be run at the root of the repository or in each package directory: | |
| - `yarn run build`: build (compile) assets, | |
| - `yarn run test`: run the tests (through Vitest), | |
| - `yarn run lint`: lint assets (through Biome.js), | |
| - `yarn run format`: format assets (through Biome.js), | |
| - `yarn run check-lint`: check assets linting (through Biome.js), | |
| - `yarn run check-format`: check assets formatting (through Biome.js) | |
| To help you with assets, we provide the following commands to lint, build, and test assets : | |
| - `yarn run build`: build (compile) assets, | |
| - `yarn run lint`: lint assets | |
| - `yarn run format`: format assets | |
| - `yarn run test`: run the tests |
You can run the following commands either at the root of the repository or within each package directory.
There was a problem hiding this comment.
i'd say "Let's focus on minimum knowledge / info "
There was a problem hiding this comment.
Yes, but commands behave differently depending of where you run them
smnandre
reviewed
Nov 27, 2024
| $ git checkout my-feature-branch && \ | ||
| git rebase upstream/2.x && \ | ||
| git push -u origin my-feature-branch | ||
| ``` |
There was a problem hiding this comment.
Just a note for late: what about addind gh cli usage ?
gh repo sync
There was a problem hiding this comment.
It was one of my first attentions, but... 🤷🏻
TIL, I always use gco 2.x && gf upstream && grb upstream/2.x && git push 😅
carsonbot
added
Status: Reviewed
Kocal
force-pushed
the
doc-contributing
branch
from
7429711
to
bf34286
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contributing was never easy for newcomers, let's simplify that a lot :) cc @smnandre
Rendered: https://github.com/Kocal/symfony-ux/blob/doc-contributing/CONTRIBUTING.md