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: add some yarn modern troubleshooting steps to developer guide #2480

Merged
merged 1 commit into from
Nov 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/developer-environment-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,12 @@ We use [gitlint](https://jorisroovers.com/gitlint/) to check commit message form
This project follows the commit message conventions outlined by [Conventional Commits](https://www.conventionalcommits.org/). Besides the standard commit types (message prefixes) **feat** and **fix**, we use some other types described there based on the Angular convention; some common ones among those are **test**, **docs**, **chore** and **refactor**. You can find the configuration details in the [.gitlint](../.gitlint) file

We also extend this prefix convention to the naming of **branches**, eg: `docs/#githubissuenumber-add-readme` or `feat/#githubissuenumber-some-feature`.

## Yarn Modern Troubleshooting

Some developers have had issues when setting up a new environment with yarn modern, corepack & asdf. Here are some steps that have worked to get the environment working in that case:

1. remove yarn from your global asdf setup (in ~/.tools-version for example)
2. run asdf reshim
3. go to cas-registration/bciers and run corepack enable
4. yarn --version should return 4.2.0 and not 1.yy.zz