Skip to content

Instantly share code, notes, and snippets.

@good-idea

good-idea/01-InitialSetup.md

Last active October 21, 2021 21:29
Show Gist options
  • Save good-idea/b032eeaed97f351a27ac6683893334d1 to your computer and use it in GitHub Desktop.
Save good-idea/b032eeaed97f351a27ac6683893334d1 to your computer and use it in GitHub Desktop.
Download ZIP
OSS Workshop instructions
Raw
01-InitialSetup.md
  1. Install Verdaccio - npm install --global verdaccio | yarn global add verdaccio
  2. Register an account and organization at npmjs.com. The org can be your github handle, or anything else you'd like. The org will be the "scope" for your package, i.e. @my-org/my-package
  3. Install [asdf](http://asdf-vm.com/guide/getting-started.html#_3-install-asdf) then run asdf install nodejs 14.17.6
Raw
02-Contributing.md

See the tutorial video here!

  1. Create a fork of the OSS Workshop repo within github
  2. Clone your forked repository to your computer
  3. Checkout to a new branch: git checkout -b fix/some-fix
  4. Make your changes to the codebase
  5. Commit your messasges using the 'conventional commits' guidelines in the repository
  6. Push your changes back up to your repo
  7. Create a pull request for your changes
Raw
03-YourOSSLibrary.md
  1. Clone the existing OSS Workshop repository. (Or your fork, if you have one)
  • We'll be using this repo as a boilerplate for our personal libraries :)
  1. In Github, create a new empty repo called toolkit.
  2. Change the following:
  • in package.json:
    • change the name of the project @your-handle/toolkit - where your-handle is the name of the Org you registered on npmjs.com
    • change the author field to be your name :)
    • change the version field to be 1.0.0
  • in all-contributorsrc, remove the values within contributors so it is just an empty array
  • in README.md, remove the <table> within the Contributors sections (but leave the comments in place!)
  1. Remove the previous remote from git: git remote rm origin
  2. Update your remote to point to this new repo: git remote add origin https://github.com/your-handle/toolkit
  3. Create a Github Personal Access Token. Make sure the repo permissions are checked.
  4. Create an NPM token
  5. Back in github, go to Settings -> Secrets
  • Click "New repository secret" and add one with the following values:
    • name: SEMANTIC_RELEASE_GH_TOKEN
    • value: The Github token you generated
  • Repeat the process and add an NPM_TOKEN
@devinhalladay
Copy link

The --global flag in Yarn is deprecated, folks using Yarn can use yarn global add verdaccio

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment