Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add "contribute" section to new docs (#1786)
Co-authored-by: alvarius <alvarius@lattice.xyz>
- Loading branch information
Showing
2 changed files
with
39 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
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,38 @@ | ||
## Contribute | ||
|
||
We'd love your support in improving MUD! [The MUD monorepo](https://github.com/latticexyz/mud) includes all of MUD's source code, and pull requests are always welcome. | ||
To discuss new features or changes [join our Discord](https://lattice.xyz/discord). | ||
|
||
You can find a list of good first issues (that don't require a lot of context on the full system) at [contribute.mud.dev](https://contribute.mud.dev). | ||
|
||
### Local development setup | ||
|
||
The following steps are only necessary if you want to contribute to MUD. To use MUD in your project, [set up a new project with the MUD CLI](/quick-start). | ||
|
||
1. Ensure you have these applications installed: | ||
|
||
| Software | Tested with version | | ||
| -------------------------------------------------------- | ------------------- | | ||
| [`curl`](https://curl.se/) | 7.74.0 | | ||
| [`node`](https://nodejs.org/en/download/package-manager) | 18.17.0 | | ||
| [`pnpm`](https://pnpm.io/) | 8.6.11 | | ||
| [`Foundry`](https://getfoundry.sh/) | 0.2.0 | | ||
|
||
1. Download the source code for MUD. | ||
|
||
```sh copy | ||
git clone https://github.com/latticexyz/mud.git | ||
cd mud | ||
``` | ||
|
||
1. Install and build packages. | ||
|
||
```sh copy | ||
pnpm install | ||
pnpm build | ||
``` | ||
|
||
### Pull requests | ||
|
||
MUD follows the [conventional commit specification](https://www.conventionalcommits.org/en/v1.0.0/) for PR titles. | ||
Please keep the scope of your PR small (rather open multiple small PRs than one huge PR). |