-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
DEVELOPMENT.md
for internal guidelines
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Weaverse SDKs Development | ||
|
||
These instructions are for internal Weaverse development. If you're looking to contribute to the Weaverse SDKs, please refer to the [Contribution Guidelines](./CONTRIBUTING.md). | ||
|
||
## Workflow | ||
|
||
We currently use [pnpm](https://pnpm.io) to develop our SDKs. | ||
|
||
1. **Fork & Clone**: Fork this repository and clone it to your local machine. | ||
|
||
2. **Install Dependencies**: Navigate to the desired package or sample project and install dependencies: | ||
|
||
```bash | ||
pnpm install | ||
``` | ||
|
||
3. **Run Development Server**: Start the development server: | ||
```bash | ||
pnpm run dev | ||
``` | ||
|
||
## Releases | ||
|
||
We're using [Changesets](https://github.com/changesets/changesets) to manage our releases. When you're ready to begin the | ||
release process, follow these steps: | ||
|
||
1. Run `pnpm changeset` to create a new changeset. | ||
2. Run `pnpm changeset version` to bump the version of the packages that need to be upgraded. | ||
3. Run `pnpm changeset publish` to publish the new version of the packages to `npm`. | ||
4. Commit and push the changes to the `main` branch. | ||
5. Release the new version of the packages on GitHub. |