Skip to content

Update CONTRIBUTING.md #7

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 26, 2025
Merged

Update CONTRIBUTING.md #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing to Asgardeo MCP Node.js SDKs
# Contributing to Asgardeo MCP Auth JavaScript SDKs

This guide walks you through setting up the development environment and other important information for contributing to
Asgardeo MCP Node.js SDKs.
Asgardeo MCP JavaScript SDKs.

We welcome contributions of all kinds, from bug fixes and documentation improvements to new features.

Expand Down Expand Up @@ -37,7 +37,7 @@ 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`)
- [Node.js](https://nodejs.org/en/download/) - JavaScript runtime. (`v20.x or higher`)
- [pnpm](https://pnpm.io/) - Alternate npm client for faster package installs. (`v8.x or higher`)

## Development Tools
Expand Down Expand Up @@ -71,13 +71,13 @@ Sorts JSON objects in alphabetical order.
Replace `<github username>` with your own username.

```shell
git clone https://github.com/<github username>/asgardeo-mcp-node.git
git clone https://github.com/<github username>/mcp-auth-javascript.git
```

3. Set the original repo as the upstream remote.

```shell
git remote add upstream https://github.com/asgardeo/asgardeo-mcp-node.git
git remote add upstream https://github.com/asgardeo/mcp-auth-javascript.git
```

## Setting up the Development Environment
Expand Down