Skip to content

Commit 4d10ca5

Browse files
authored
First part of the contribution-guidlines
1 parent fbb4945 commit 4d10ca5

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# How to contribute
2+
3+
You want help me make BlueMap better? Awesome!<br>
4+
Here you learn how it works and what you need to know before contributing.
5+
6+
>**Please read this before creating an Issue or a PullRequest!** Issues/PR's that don't follow these instructions will be closed!<br>
7+
>**Issues are NOT for asking questions!** If you have a question, please use our [Discord](https://discord.gg/zmkyJa3) or [Reddit](https://www.reddit.com/r/BlueMap/)!
8+
9+
### Table of Contents
10+
- [Reporting a Bug](#reporting-a-bug)
11+
- [Suggesting a new feature or change](#suggesting-a-new-feature-or-change)
12+
- [Creating a Pull-Request](#creating-a-pull-request)
13+
14+
## Reporting a Bug
15+
The first thing you need to do, is to make sure what you found is actually a bug:<br>
16+
- A bug is an unintended behaviour of an implemented feature.
17+
BlueMap is not "done", there are quite a lot of features missing!
18+
So, if something doesn't work because it is not implemented yet, its not a bug.
19+
If you are not sure, you can briefly ask about it in our [Discord](https://discord.gg/zmkyJa3) before creating an Issue. :)
20+
- Make sure you tested it well enough to be sure it's not an issue on your end. If something doesn't work for you but for everyone else, its probably **not** a bug!
21+
22+
Also, please make sure noone else has already reported the same or a very similar bug!
23+
If you have additional information for an existing bug-report, you can add a comment to the already existing Issue :)
24+
25+
To report your bug, please open a [new Issue](https://github.com/BlueMap-Minecraft/BlueMap/issues/new?template=bug_report.md) with the `Bug report`-template and follow these guidlines:
26+
27+
### Guidlines for a good Bug-Issue
28+
**A short, informative Title**<br>
29+
Your Issue should have a short but informative title, which makes it possible to distinquish it from- and easily recognize it in-between- other Issues.
30+
If someone else finds the same bug, they should be able to find your Issue only based on the title!
31+
32+
**A detailed description**<br>
33+
Describe your bug in as much detail as possible:
34+
- What did you do before it happened? (How can the bug be reproduced?)
35+
- What did you expect to happen?
36+
- What happened instead?
37+
- CONTEXT!!
38+
- The exact BlueMap-Version (e.g. the name of the used .jar file)
39+
- The used os and platform (Windows/Linux, Spigot/Paper/Forge/Fabric/Sponge)
40+
- Has the world been generated using any minecraft-mods?
41+
- etc..
42+
- Is there a log- or a config-file that might help? Include it.
43+
- Maybe add a screenshot or video for illustration.
44+
45+
**Well formatted and structured**<br>
46+
Make sure your Issue is easy to read and not a mess:
47+
- Use paragraphs to structure your issue.
48+
- Use [Markdown](https://guides.github.com/features/mastering-markdown/) to add headings and formatting.
49+
- Use codeblocks for log-snippets.
50+
- Upload full logs as file-attachments or use a paste-site like [GitHub Gists](https://gist.github.com/) or [Pastebin](https://pastebin.com/).
51+
52+
**One Issue, one bug**<br>
53+
Create a separate Issue for each bug you find! Issues that contain more than one bug will be closed!
54+
55+
## Suggesting a new feature or change
56+
**(Todo)**
57+
58+
## Creating a Pull-Request
59+
**(Todo)**

0 commit comments

Comments
 (0)