docs: update contributing guide to reflect Asgardeo JavaScript SDKs

brionmario · brionmario · commit 8e318fa06e31 · 2025-09-29T00:31:02.000+05:30
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,9 @@
-# Contributing to Asgardeo Web UI SDKs
+# Contributing to Asgardeo JavaScript SDKs
 
-This guide walks you through setting up the development environment and other important information for contributing to Asgardeo Web UI SDKs.
+This guide walks you through setting up the development environment and other important information for contributing to Asgardeo JavaScript SDKs.
 
 ## Table of Contents
+
 - [Prerequisite Software](#prerequisite-software)
 - [Development Tools](#development-tools)
   - [NX Console](#nx-console)
@@ -26,44 +27,18 @@ This guide walks you through setting up the development environment and other im
 
 To build and write code, make sure you have the following set of tools on your local environment:
 
-* [Git](https://git-scm.com/downloads) - Open source distributed version control system. For install instructions, refer [this](https://www.atlassian.com/git/tutorials/install-git).
-* [Node.js](https://nodejs.org/en/download/) - JavaScript runtime. (`v18 or higher`)
-* [pnpm](https://pnpm.io/) - Alternate npm client for faster package installs. (`v9 or higher`)
+- [Git](https://git-scm.com/downloads) - Open source distributed version control system. For install instructions, refer [this](https://www.atlassian.com/git/tutorials/install-git).
+- [Node.js](https://nodejs.org/en/download/) - JavaScript runtime. (`v18 or higher`)
+- [pnpm](https://pnpm.io/) - Alternate npm client for faster package installs. (`v9 or higher`)
 
 ## Development Tools
 
-### NX Console
-
-Editor plugin which wraps NX commands so you don't have to memorize.
-
-- [Install for VS Code](https://marketplace.visualstudio.com/items?itemName=nrwl.angular-console)
-- [Install for VS Web Storm](https://plugins.jetbrains.com/plugin/15000-nx-webstorm)
-
-### React Developer Tools
-
-Browser extension to debug React code.
-
-- [Download for Chrome](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
-- [Download for Firefox](https://addons.mozilla.org/en-US/firefox/addon/react-devtools/)
-
-### ESLint Plugin
-
-Static code analysis tool for identifying problematic patterns found in JavaScript/Typescript code.
-
-- [Install for VS Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
-- [Install for VS Web Storm](https://www.jetbrains.com/help/webstorm/eslint.html)
-
-### Code Spell Checker
-
-A basic spell checker that works well with code and documents.
-
-- [Install for VS Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
-
-### JSON Sort Order
-
-Sorts JSON objects in alphabetical order.
-
-- [Install for VS Code](https://marketplace.visualstudio.com/items?itemName=msyesyan.json-sorter)
+| Extension | Description | VS Code Marketplace |
+|-----------|-------------|---------------------|
+| NX Console | Editor plugin which wraps NX commands so you don't have to memorize. | [Install](https://marketplace.visualstudio.com/items?itemName=nrwl.angular-console) |
+| ESLint | Static code analysis tool for identifying problematic patterns found in JavaScript/Typescript code. | [Install](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) |
+| Code Spell Checker | A basic spell checker that works well with code and documents. | [Install](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) |
+| JSON Sort Order | Sorts JSON objects in alphabetical order. | [Install](https://marketplace.visualstudio.com/items?itemName=msyesyan.json-sorter) |
 
 ## Setting up the Source Code
 
@@ -98,151 +73,86 @@ pnpm build
 
 ## Contributing to the Documentation
 
-We use [Vitepress](https://vitepress.dev/) to generate the documentation site. The documentation site is located in the `docs` directory.
-To contribute to the documentation, you can follow the steps below to start the Vitepress server locally.
+The documentation for Asgardeo JavaScript SDKs is maintained in the Asgardeo / WSO2 Identity Server Official Docs site.
 
-1. Navigate to the `docs` directory.
+- [Asgardeo Docs](https://wso2.com/asgardeo/docs)
+- [WSO2 Identity Server Docs](https://is.docs.wso2.com/en/latest/)
 
-```bash
-cd docs
-```
-
-2. Start the Vitepress server.
-
-```bash
-pnpm docs:dev
-```
+To contribute to the documentation, please send a pull request to the [Asgardeo Docs repository](https://github.com/wso2/docs-is).
 
 ## Commit Message Guidelines
 
-*This specification is inspired by and supersedes the [AngularJS commit message format][commit-message-format].*
-
-We have very precise rules over how our Git commit messages must be formatted.
-This format leads to **easier to read commit history**.
-
-Each commit message consists of a **header**, a **body**, and a **footer**.
-
-```
-<header>
-<BLANK LINE>
-<body>
-<BLANK LINE>
-<footer>
-```
-
-The `header` is mandatory and must conform to the [Commit Message Header](#commit-header) format.
-
-The `body` is mandatory for all commits except for those of type "docs".
-When the body is present it must be at least 20 characters long and must conform to the [Commit Message Body](#commit-body) format.
+We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) as the commit message convention.
 
-The `footer` is optional. The [Commit Message Footer](#commit-footer) format describes what the footer is used for and the structure it must have.
+Please refer to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) documentation for more information.
 
+> [!IMPORTANT]
+>
+> 1. Use the imperative, present tense: "change" not "changed" nor "changes".
+> 2. Don't capitalize the first letter.
+> 3. No dot (.) at the end.
 
-### <a name="commit-header"></a>Commit Message Header
-
-```
-<type>(<scope>): <short summary>
-  │       │             │
-  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
-  │       │
-  │       └─⫸ Commit Scope: primitives|scss|react|vue|nuxt
-  │
-  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|chore|test
-```
-
-The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional.
-
-
-#### Type
+### Types
 
 Must be one of the following:
 
-* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
-* **ci**: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs)
-* **docs**: Documentation only changes
-* **feat**: A new feature
-* **fix**: A bug fix
-* **perf**: A code change that improves performance
-* **refactor**: A code change that neither fixes a bug nor adds a feature
-* **chore**: Housekeeping tasks that doesn't require to be highlighted in the changelog
-* **test**: Adding missing tests or correcting existing tests
+- **chore**: Housekeeping tasks that doesn't require to be highlighted in the changelog
+- **feat**: A new feature
+- **ci**: Changes to our CI configuration files and scripts (examples: GitHub Actions)
+- **fix**: A bug fix
+- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+- **docs**: Documentation only changes
+- **perf**: A code change that improves performance
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **test**: Adding missing tests or correcting existing tests
 
+### Scope
 
-#### Scope
 The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages).
 
 The following is the list of supported scopes:
 
-* `core` - Changes to the `core` / `@asgardeo/js` package.
-* `react` - Changes to the `@asgardeo/react` package.
-* `vue` - Changes to the `@asgardeo/vue` package.
-* `nuxt` - Changes to the `@asgardeo/nuxt` package.
-* `workspace` - Changes to the workspace.
-* `sample-app` - Changes to the sample app.
-
-There are currently a few exceptions to the "use package name" rule:
-
-* `packaging`: used for changes that change the npm package layout in all of our packages, e.g. public path changes, package.json changes done to all packages, d.ts file/format changes, changes to bundles, etc.
-
-* `changelog`: used for updating the release notes in CHANGELOG.md
-
-* `dev-infra`: used for dev-infra related changes within the directories like /scripts.
-
-* `docs-infra`: used for docs page changes. (`<ROOT>/docs`)
-
-* none/empty string: useful for `test` and `refactor` changes that are done across all packages (e.g. `test: add missing unit tests`) and for docs changes that are not related to a specific package (e.g. `docs: fix typo in example`).
-
-
-#### Summary
-
-Use the summary field to provide a succinct description of the change:
+- `javascript` - Changes to the `@asgardeo/javascript` package.
+- `browser` - Changes to the `@asgardeo/browser` package.
+- `node` - Changes to the `@asgardeo/node` package.
+- `express` - Changes to the `@asgardeo/express` package.
+- `i18n` - Changes to the `@asgardeo/i18n` package.
+- `react` - Changes to the `@asgardeo/react` package.
+- `react-router` - Changes to the `@asgardeo/react-router` package.
+- `nextjs` - Changes to the `@asgardeo/nextjs` package.
+- `vue` - Changes to the `@asgardeo/vue` package.
+- `nuxt` - Changes to the `@asgardeo/nuxt` package.
 
-* Use the imperative, present tense: "change" not "changed" nor "changes".
-* Don't capitalize the first letter.
-* No dot (.) at the end.
+> [!NOTE]
+> If the change affects multiple packages, just use the type without a scope, e.g., `fix: ...`.
 
+### Example Commit Message
 
-### <a name="commit-body"></a>Commit Message Body
-
-Just as in the summary, use the imperative, present tense: "fix" not "fixed" nor "fixes".
-
-Explain the motivation for the change in the commit message body. This commit message should explain _why_ you are making the change.
-You can include a comparison of the previous behavior with the new behavior in order to illustrate the impact of the change.
-
-
-### <a name="commit-footer"></a>Commit Message Footer
-
-The footer can contain information about breaking changes and deprecations and is also the place to reference GitHub issues, Jira tickets, and other PRs that this commit closes or is related to.
-For example:
+Each commit message consists of a **header**, a **body**, and a **footer**.
 
 ```
-BREAKING CHANGE: <breaking change summary>
-<BLANK LINE>
-<breaking change description + migration instructions>
+<type>(<scope>): <short summary>
 <BLANK LINE>
+<body>
 <BLANK LINE>
-Fixes #<issue number>
+<footer>
 ```
 
-or
-
-```
-DEPRECATED: <what is deprecated>
-<BLANK LINE>
-<deprecation description + recommended update path>
-<BLANK LINE>
-<BLANK LINE>
-Closes #<pr number>
 ```
+# Update issue templates to include '@asgardeo/i18n' and improve version description
+chore: update issue templates to include '@asgardeo/i18n' and improve version description
 
-Breaking Change section should start with the phrase "BREAKING CHANGE: " followed by a summary of the breaking change, a blank line, and a detailed description of the breaking change that also includes migration instructions.
+# Add a new feature to the react package.
+feat(react): add `SignInWithPopup` method to facilitate popup-based authentication flows.
 
-Similarly, a Deprecation section should start with "DEPRECATED: " followed by a short description of what is deprecated, a blank line, and a detailed description of the deprecation that also mentions the recommended update path.
+# Update GitHub Actions workflows to include linting and testing steps.
+ci: enhance GitHub Actions workflows with linting and testing steps
 
+```
 
 ### Revert commits
 
-If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.
+If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit.
 
 The content of the commit message body should contain:
 
