Pumpkin-MC/Pumpkin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
lukas0008 2024-09-07 21:21:59 +02:00
parent ef3923c521
commit 0d6f7b49ab
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -25,6 +25,20 @@ There are several ways you can contribute to Pumpkin:
Ensure your code adheres to our project structure and style guidelines. Ensure your code adheres to our project structure and style guidelines.
Write clear and concise commit messages that describe your changes. Write clear and concise commit messages that describe your changes.
### Faster Compiles
We use extism for our plugins, unfortunately extism has quite a hefty impact on compile times, which can increase it by several minutes on release mode. To run Pumpkin without plugins, run the following:
```shell
cargo run --no-default-features
```
And in release:
```shell
cargo run --no-default-features --release
```
### Project Structure ### Project Structure
Before contributing, it would be helpful to get to know the project structure, for further information, visit [STRUCTURE.md](STRUCTURE.md) Before contributing, it would be helpful to get to know the project structure, for further information, visit [STRUCTURE.md](STRUCTURE.md)