From 22c71680722730880b1f69c9296c0b75ff31ba2f Mon Sep 17 00:00:00 2001 From: Nandan Hegde <220186393+nandanhegde73@users.noreply.github.com> Date: Tue, 2 Dec 2025 22:39:32 +0530 Subject: [PATCH 1/4] Replace CONTRIBUTING.md file with standard template Signed-off-by: Nandan Hegde <220186393+nandanhegde73@users.noreply.github.com> --- CONTRIBUTING.md | 76 ++----------------------------------------------- 1 file changed, 2 insertions(+), 74 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 91e031c..20cc921 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,75 +1,3 @@ -# Contributing to vscode-chef +# Contributing to a Progress Chef Workstation Project -Thank you for your interest in contributing to the Progress Chef VS Code extension! - -## General Contribution Guidelines - -For general Chef contribution guidelines, including DCO requirements, PR process, and code review standards, see: -https://github.com/chef/chef/blob/master/CONTRIBUTING.md - -## Development Setup - -Complete build and development instructions are available in the README: -**[Building and releasing the extension](README.md#building-and-releasing-the-extension)** - -### Quick Reference - -```bash -# Install dependencies (always use npm ci, not npm install) -npm ci - -# Build the extension -npm run vscode:prepublish - -# Package for local testing -npm run package - -# Test locally -code --install-extension ./chef-.vsix -``` - -### Key Requirements - -- **Always use `npm ci`** for builds (never `npm install` unless updating dependencies) -- **Commit `package-lock.json`** with any dependency changes -- **Sign-off all commits**: Use `git commit -s` (DCO requirement) -- **Exact versions only**: No `^` or `~` in `package.json` -- All packages install from Harness Artifact Registry (HAR) - -### Team Policy - -- ✅ Always use `npm ci` for builds -- ✅ Commit `package-lock.json` with any dependency changes -- ✅ CI/CD uses `npm ci` (frozen lockfile enforced) -- ❌ Never commit `node_modules/` -- ❌ Never use `npm install` unless updating dependencies - -### Build Verification - -To verify your build matches the frozen lockfile: - -```bash -rm -rf node_modules -npm ci -npm run vscode:prepublish -npm run package -``` - -### Pull Request Checklist - -Before submitting your PR, ensure: - -- [ ] Code builds successfully (`npm run vscode:prepublish`) -- [ ] Extension packages successfully (`npm run package`) -- [ ] Tested locally by installing the `.vsix` file -- [ ] All commits are signed-off (DCO) -- [ ] `package-lock.json` updated if dependencies changed -- [ ] No unrelated changes included - -### Need Help? - -- **Issues**: [GitHub Issues](https://github.com/chef/vscode-chef/issues) -- **Detailed build instructions**: [README.md](README.md#building-and-releasing-the-extension) -- **Chef Community**: [Community Slack](https://community-slack.chef.io/) - -For detailed explanations of dependency management, team policies, and security requirements, see the README. +Thank you for your interest in contributing to this project! It is part of the larger Progress Chef Workstation project. Contribution guidelines can be found at [Contributing to Progress Chef Workstation](https://chef.github.io/chef-oss-practices/projects/workstation/contributing/). From c9aaf9892a8343860c1b00ce7b567f8a2989d99e Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Mon, 17 Aug 2026 16:11:36 +0530 Subject: [PATCH 2/4] Update README.md with improved development guidelines - Remove duplicate 'Install dependencies' section - Add Quick Reference section with all essential commands - Add Build Verification steps - Add Pull Request Checklist with DCO requirement - Add Need Help section with support links - Simplify Packaging/releasing section - Add Community Slack link to Contributions section - Fix typo: 'Command Pallette' -> 'Command Palette' - Update image URL from master to main branch - Use consistent bash code block formatting - Remove verbose output examples for cleaner documentation - Remove outdated CONTRIBUTING.md reference All essential build, test, and release commands preserved. Documentation is now cleaner, better organized, and more helpful. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: nikhil2611 --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 44 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cd2f6ae..7db4023 100644 --- a/README.md +++ b/README.md @@ -51,20 +51,57 @@ The Progress Chef Infra Extension for Visual Studio Code offers rich language su Contributions are welcomed, please file issues and pull requests via the [project homepage](https://github.com/chef/vscode-chef). +- **Community Slack**: [Chef Community](https://community-slack.chef.io/) + ## Building and releasing the extension This project contains development launch settings. A recent Node.js LTS build is required. -### Install dependencies +### Quick Reference -Dependencies for development work of this extension are maintained in the `package.json` file under the `devDependencies` key and can be installed via NPM: +```bash +# Install dependencies (always use npm ci, not npm install) +npm ci -```shell -npm ci # Recommended: installs from frozen lockfile -npm install # Only when updating dependencies +# Build the extension +npm run vscode:prepublish + +# Package for local testing +npm run package + +# Test locally +code --install-extension ./chef-.vsix ``` -**Note:** For team development, always use `npm ci` to ensure reproducible builds. See [CONTRIBUTING.md](CONTRIBUTING.md) for details. +**Note:** Always commit `package-lock.json` when updating dependencies. + +### Build Verification + +To verify your build matches the frozen lockfile: + +```bash +rm -rf node_modules +npm ci +npm run vscode:prepublish +npm run package +``` + +### Pull Request Checklist + +Before submitting your PR, ensure: + +- [ ] Code builds successfully (`npm run vscode:prepublish`) +- [ ] Extension packages successfully (`npm run package`) +- [ ] Tested locally by installing the `.vsix` file +- [ ] All commits are signed-off (DCO): Use `git commit -s` +- [ ] `package-lock.json` updated if dependencies changed +- [ ] No unrelated changes included + +### Need Help? + +- **Issues**: [GitHub Issues](https://github.com/chef/vscode-chef/issues) +- **Detailed build instructions**: See sections above +- **Chef Community**: [Community Slack](https://community-slack.chef.io/) ### Updating Snippets @@ -139,7 +176,7 @@ To test the extension locally: code --install-extension C:\projects\chef\vscode-chef\chef-1.4.0.vsix ``` -To release requires a PAT token for the relevant publisher on the Visual Studio Marketplace. +To release requires a PAT token for the relevant publisher on the Visual Studio Marketplace: ```plain vsce publish From 178e6ca8a5384507e3eec0b14d6c49c4da162728 Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Mon, 17 Aug 2026 17:05:12 +0530 Subject: [PATCH 3/4] Fix Copyright heading to be consistent with other sections Changed Copyright from h1 to h2 heading to match the formatting of other sections like Features, Installation, and Contributions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: nikhil2611 --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7db4023..c9289d4 100644 --- a/README.md +++ b/README.md @@ -216,5 +216,6 @@ This extension is licensed under an [Apache 2](LICENSE) license. limitations under the License. ``` -# Copyright +## Copyright + See [COPYRIGHT.md](./COPYRIGHT.md). From 9df25771a84bd5b1309c5b5bbf7bee94909e9e66 Mon Sep 17 00:00:00 2001 From: nikhil2611 Date: Mon, 17 Aug 2026 17:10:18 +0530 Subject: [PATCH 4/4] Trigger CI checks Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: nikhil2611