Skip to content
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

Jump to bottom

docs(contribute): added to new docs #1786

Merged
merged 4 commits into from
Oct 20, 2023
Merged

docs(contribute): added to new docs #1786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4db9129
docs(contribute): added to new docs
qbzzt Oct 16, 2023
bf33f48
Apply suggestions from code review
alvrs Oct 17, 2023
fc61495
Apply suggestions from code review
alvrs Oct 17, 2023
2ebae34
added foundry to the list of required software
qbzzt Oct 17, 2023
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
1 change: 1 addition & 0 deletions next-docs/pages/_meta.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export default {
plugins: "Plugins",
templates: "Templates",
guides: "Guides",
contribute: "Contribute",
changelog: "Changelog",
retrospectives: "Retrospectives",
// --------------------
Expand Down
38 changes: 38 additions & 0 deletions next-docs/pages/contribute.mdx
View file
Open in desktop
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).
Loading