mirror of
https://github.com/Pumpkin-MC/Pumpkin.git
synced 2026-08-30 20:14:23 +00:00
Added detailed documentation on how to contribute (#205)
This commit is contained in:
@@ -24,18 +24,14 @@ export default defineConfig({
|
||||
{
|
||||
text: "Developers",
|
||||
items: [
|
||||
{
|
||||
text: "Contributing",
|
||||
link: "https://github.com/Snowiiii/Pumpkin/blob/master/CONTRIBUTING.md",
|
||||
},
|
||||
{ text: "Contributing", link: "/developer/contributing", },
|
||||
{ text: "Introduction", link: "/developer/introduction" },
|
||||
{ text: "Networking", link: "/developer/networking" },
|
||||
{ text: "Authentication", link: "/developer/authentication" },
|
||||
{ text: "RCON", link: "/developer/rcon" },
|
||||
{ text: "World", link: "developer/world"},
|
||||
],
|
||||
},
|
||||
|
||||
},
|
||||
{
|
||||
text: "Configuration",
|
||||
items: [
|
||||
|
||||
53
docs/developer/contributing.md
Normal file
53
docs/developer/contributing.md
Normal file
@@ -0,0 +1,53 @@
|
||||
### Contributing to Pumpkin
|
||||
We appreciate your interest in contributing to Pumpkin! This document outlines the guidelines for submitting bug reports, feature suggestions, and code changes.
|
||||
|
||||
### Getting Started
|
||||
The easiest way to get started is by asking for help in our [discord](https://discord.gg/wT8XjrjKkf).
|
||||
|
||||
### How to Contribute
|
||||
There are several ways you can contribute to Pumpkin:
|
||||
|
||||
#### Reporting Bugs
|
||||
If you encounter a bug, please search for existing issues on the issue tracker first.
|
||||
|
||||
If you can't find a duplicate issue, open a new one.
|
||||
|
||||
Follow the template and provide a clear description of the bug, including steps to reproduce it if possible.
|
||||
Screenshots, logs, or code snippets can also be helpful.
|
||||
|
||||
#### Suggesting Features
|
||||
Do you have an idea on how Pumpkin can be improved? Share your thoughts by opening an issue on the issue tracker.
|
||||
|
||||
Describe the proposed feature in detail, including its benefits and potential implementation considerations.
|
||||
|
||||
#### Contributing Code
|
||||
To get started with contributing code to Pumpkin, fork the repository on github
|
||||
|
||||
- First create a github account if you don't already have one
|
||||
|
||||
- Go to Pumpkin's Official [Github Repository](https://github.com/Snowiiii/Pumpkin) and press fork
|
||||
|
||||
> Creating a fork means you now have your own copy of the Pumpkin source code, (this does not mean you own the copyright)
|
||||
|
||||
Now that you have a copy that you can edit, you will need a few tools
|
||||
|
||||
- Install [git](https://git-scm.com/downloads) for your operating system
|
||||
|
||||
- To get started with git, visit [Getting started with Git](https://docs.github.com/en/get-started/getting-started-with-git)
|
||||
|
||||
- Optional: If you want a graphical tool to interact with Github, install [Github-Desktop](https://desktop.github.com/download/)
|
||||
|
||||
> Github Desktop may be easier if you are not used to the command line, but it is not for everyone
|
||||
|
||||
- To get started with Github Desktop, visit [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/overview/getting-started-with-github-desktop)
|
||||
|
||||
- If you are wanting to contribut code, install Rust at [rust-lang.org](https://www.rust-lang.org/).
|
||||
|
||||
- If you are wanting to contribute to documentation, install [NodeJS](https://nodejs.org/en)
|
||||
|
||||
### Additional Information
|
||||
We encourage you to comment on existing issues and pull requests to share your thoughts and provide feedback.
|
||||
|
||||
Feel free to ask questions in the issue tracker or reach out to the project maintainers if you need assistance.
|
||||
|
||||
Before submitting a large contribution, consider opening an issue, discussion or talk with us on our discord to discuss your approach.
|
||||
Reference in New Issue
Block a user