Merge pull request #11 from 3nethz/main

Update package names

Author: brionmario

.changeset/polite-lands-strive.md

@@ -1,6 +1,7 @@
 # Contributing to Asgardeo MCP Node.js SDKs
 
-This guide walks you through setting up the development environment and other important information for contributing to Asgardeo MCP Node.js SDKs.
+This guide walks you through setting up the development environment and other important information for contributing to
+Asgardeo MCP Node.js SDKs.
 
 We welcome contributions of all kinds, from bug fixes and documentation improvements to new features.
 
@@ -35,9 +36,9 @@ We welcome contributions of all kinds, from bug fixes and documentation improvem
 
 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.
-* [Node.js](https://nodejs.org/en/download/) - JavaScript runtime. (`v16.x or higher`)
-* [pnpm](https://pnpm.io/) - Alternate npm client for faster package installs. (`v8.x or higher`)
+- [Git](https://git-scm.com/downloads) - Open source distributed version control system.
+- [Node.js](https://nodejs.org/en/download/) - JavaScript runtime. (`v16.x or higher`)
+- [pnpm](https://pnpm.io/) - Alternate npm client for faster package installs. (`v8.x or higher`)
 
 ## Development Tools
 
@@ -95,10 +96,11 @@ pnpm build
 
 ## Project Structure
 
-The asgardeo-mcp-node repository is a monorepo containing the following key packages located in the `packages/` directory:
+The asgardeo-mcp-node repository is a monorepo containing the following key packages located in the `packages/`
+directory:
 
-- `packages/mcp-node` (`@brionmario-experimental/mcp-node`): Core Node.js utilities for MCP.
-- `packages/mcp-express` (`@brionmario-experimental/mcp-express`): Express middleware for MCP, likely dependent on mcp-node.
+- `packages/mcp-node` (`@asgardeo/mcp-node`): Core Node.js utilities for MCP.
+- `packages/mcp-express` (`@asgardeo/mcp-express`): Express middleware for MCP, likely dependent on mcp-node.
 
 Shared configurations (like ESLint, Prettier, TypeScript) are typically managed at the root level.
 
@@ -123,39 +125,42 @@ Shared configurations (like ESLint, Prettier, TypeScript) are typically managed
 You can build all packages or a specific package:
 
 **Build all packages:**
+
 ```bash
 pnpm run build
 # or if you have a specific script for all packages
 # pnpm run build:all
 ```
 
-**Build a specific package:**
-Use the `--filter` flag with pnpm. Replace `<package-name>` with the actual package name (e.g., `@brionmario-experimental/mcp-express`).
+**Build a specific package:** Use the `--filter` flag with pnpm. Replace `<package-name>` with the actual package name
+(e.g., `@asgardeo/mcp-express`).
 
 ```bash
 pnpm --filter <package-name> run build
 
 # Example for mcp-express:
-pnpm --filter @brionmario-experimental/mcp-express run build
+pnpm --filter @asgardeo/mcp-express run build
 ```
 
 ### Linting Code
 
 Ensure your code adheres to the project's linting standards:
 
 **Lint all packages:**
+
 ```bash
 pnpm run lint
 # or
 # pnpm run lint:all
 ```
 
 **Lint a specific package:**
+
 ```bash
 pnpm --filter <package-name> run lint
 
 # Example for mcp-node:
-pnpm --filter @brionmario-experimental/mcp-node run lint
+pnpm --filter @asgardeo/mcp-node run lint
 ```
 
 You can also run lint fix scripts if available (e.g., `pnpm run lint:fix`).
@@ -165,26 +170,28 @@ You can also run lint fix scripts if available (e.g., `pnpm run lint:fix`).
 Ensure all existing tests pass and add new tests for your changes:
 
 **Test all packages:**
+
 ```bash
 pnpm run test
 # or
 # pnpm run test:all
 ```
 
 **Test a specific package:**
+
 ```bash
 pnpm --filter <package-name> run test
 
 # Example for mcp-express:
-pnpm --filter @brionmario-experimental/mcp-express run test
+pnpm --filter @asgardeo/mcp-express run test
 ```
 
 ## Commit Message Guidelines
 
-*This specification is inspired by and supersedes the [AngularJS commit message format][commit-message-format].*
+_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**.
+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**.
 
@@ -198,10 +205,11 @@ Each commit message consists of a **header**, a **body**, and a **footer**.
 
 The `header` is mandatory and must conform to the [Commit Message Header](#commit-message-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-message-body) 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-message-body) format.
 
-The `footer` is optional. The [Commit Message Footer](#commit-message-footer) format describes what the footer is used for and the structure it must have.
+The `footer` is optional. The [Commit Message Footer](#commit-message-footer) format describes what the footer is used
+for and the structure it must have.
 
 ### Commit Message Header
 
@@ -221,54 +229,59 @@ The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is opti
 
 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
+- **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
 
 #### 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 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:
 
-* `mcp-node` - Changes to the `@brionmario-experimental/mcp-node` package.
-* `mcp-express` - Changes to the `@brionmario-experimental/mcp-express` package.
-* `workspace` - Changes to the workspace.
-* `sample-app` - Changes to the sample app.
+- `mcp-node` - Changes to the `@asgardeo/mcp-node` package.
+- `mcp-express` - Changes to the `@asgardeo/mcp-express` 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.
-* 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`).
+- `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.
+- 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:
 
-* Use the imperative, present tense: "change" not "changed" nor "changes".
-* Don't capitalize the first letter.
-* No dot (.) at the end.
+- Use the imperative, present tense: "change" not "changed" nor "changes".
+- Don't capitalize the first letter.
+- No dot (.) at the end.
 
 ### 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.
+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.
 
 ### 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:
+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:
 
 ```
 BREAKING CHANGE: <breaking change summary>
@@ -290,9 +303,11 @@ DEPRECATED: <what is deprecated>
 Closes #<pr number>
 ```
 
-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.
+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.
 
-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.
+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.
 
 ### Revert Commits
 
@@ -311,19 +326,22 @@ The content of the commit message body should contain:
    ```bash
    git push origin feat/your-feature-name
    ```
-4. Go to the original `brionmario/asgardeo-mcp-node` repository on GitHub and open a new Pull Request from your forked branch to the `main` branch of the upstream repository.
+4. Go to the original `brionmario/asgardeo-mcp-node` repository on GitHub and open a new Pull Request from your forked
+   branch to the `main` branch of the upstream repository.
 5. Provide a clear title and a detailed description for your Pull Request:
    - Explain the "why" and "what" of your changes.
    - Reference any related GitHub issues (e.g., "Closes #123").
    - Include steps for testing if applicable.
-6. Your Pull Request will be reviewed by maintainers. Be prepared to discuss your changes and make adjustments based on feedback.
+6. Your Pull Request will be reviewed by maintainers. Be prepared to discuss your changes and make adjustments based on
+   feedback.
 7. Once approved and all checks pass, your PR will be merged.
 
 ## Reporting Bugs
 
 If you encounter a bug, please help us by reporting it!
 
-1. **Search existing issues**: Before creating a new issue, please check if the bug has already been reported on the GitHub Issues page.
+1. **Search existing issues**: Before creating a new issue, please check if the bug has already been reported on the
+   GitHub Issues page.
 2. **Create a new issue**: If it's a new bug, please provide a detailed report including:
    - A clear and descriptive title.
    - Steps to reproduce the bug.
@@ -333,18 +351,20 @@ If you encounter a bug, please help us by reporting it!
 
 ### Security Vulnerabilities
 
-Do not report security vulnerabilities through public GitHub issues.
-Please report security vulnerabilities directly to security@wso2.com. We strongly advise following the WSO2 Security Vulnerability Reporting Guidelines.
+Do not report security vulnerabilities through public GitHub issues. Please report security vulnerabilities directly to
+security@wso2.com. We strongly advise following the WSO2 Security Vulnerability Reporting Guidelines.
 
 ## Suggesting Enhancements
 
 We welcome suggestions for new features or improvements!
 
 1. **Search existing issues/discussions**: Check if your idea has already been discussed.
-2. **Create a new issue**: Provide a clear description of the proposed enhancement, why it would be beneficial, and any potential implementation details.
+2. **Create a new issue**: Provide a clear description of the proposed enhancement, why it would be beneficial, and any
+   potential implementation details.
 
 ## License
 
-By contributing to this project, you agree that your contributions will be licensed under the same license as the project itself.
+By contributing to this project, you agree that your contributions will be licensed under the same license as the
+project itself.
 
 [commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit