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

Colin/docs update and tickets added for contributers #36

Merged
merged 2 commits into from
Dec 11, 2024
Merged

Conversation

12mv2
Copy link
Collaborator

@12mv2 12mv2 commented Nov 30, 2024

Description

Create a detailed guide explaining all npm scripts available in the project, their purposes, and when to use them during development.

Task Requirements

  1. Document each script in package.json
  2. Explain when and why to use each script
  3. Provide example use cases
  4. Include common troubleshooting tips

Scripts to Document

{
"build": "npm run compile && webpack --config webpack.config.js",
"build:prod": "npm run compile && webpack --config webpack.prod.js",
"compile": "tsc -p ./tsconfig.json",
"webpack": "webpack",
"watch": "concurrently "webpack --watch" "tsc -watch -p ./tsconfig.json"",
"lint": "eslint src",
"pretest": "npm run compile",
"test": "node ./out/test/runTest.js",
"test:parser-performance": "TEST_SUITE=parser-performance npm run test",
"package": "vsce package"
}

Branch

Please work on branch: yourname/35-development-scripts-guide

git checkout main
git pull
git checkout -b yourname/35-development-scripts-guide

Just replace yourname with your first name (lowercase). For example:

  • bif/35-development-scripts-guide
  • elmo/35-development-scripts-guide
  • bart/35-development-scripts-guide

@12mv2 12mv2 requested review from MZiegler96 and susanalam December 2, 2024 05:23
@12mv2 12mv2 changed the base branch from dev to main December 11, 2024 22:40
@12mv2 12mv2 merged commit 869287e into main Dec 11, 2024
2 checks passed
@12mv2 12mv2 deleted the colin/docs-update branch December 12, 2024 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant