salesforce / salesforce/design-system-react

Update readme: How to fork, build, tag and install

Open
#2,176 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
JavaScript
Stars
982
Forks
440
Avg merge
1d 21h
Merged PRs (30d)
4

Description

Update https://github.com/salesforce/design-system-react/blob/master/docs/release.md#release-to-your-own-fork

You can't override scope such as @salesforce for one thing. A fork will create a design-system-react folder in your node_modules folder.

Webpack module resolve might be a good option.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/release.md at the “release to your own fork” section and follow the documented fork, build, tag, and install flow. Verify how the fork appears in node_modules and review the suggested Webpack module resolve option; the documentation is done when these steps accurately explain the scope and installation differences.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, webpack
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.