From 0960ac1f863c3814aebc8a36ffceda9c65aed6be Mon Sep 17 00:00:00 2001 From: Ferdinand Keller Date: Fri, 2 Aug 2024 09:53:42 +0000 Subject: [PATCH] added contributing instructions --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..96d543f75 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +## Contributing to Pumpkin + +Pumpkin is an open-source project that welcomes contributions. There are many ways to contribute, but if you want to do so by providing code and implementing features, the following standard development workflow is recommended: + +- Fork the repository +- Create a new branch +- Use a modern IDE that supports devcontainers (VSCode, IntelliJ, etc.) +- Wait for dependencies and tools to be installed +- Apply your changes +- Run the tests (WIP) +- Create a pull request + +> If you need to take a peek at Mojang's server code, you can check it out in the `mc-source-code` folder by running the `decompile.sh` script. It will setup everything for you automatically. \ No newline at end of file