Skip to content

Commit 3cc1b3a

Browse files
authored
🔀 Merge pull request #4 from nodeSoftwares/Michalex37220-patch-1
📑 Added CONTRIBUTING
2 parents 66e8006 + 4902647 commit 3cc1b3a

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

CONTRIBUTING.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<!-- omit in toc -->
2+
# Contributing to Meio
3+
4+
First off, thanks for taking the time to contribute! ❤️
5+
6+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
7+
8+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
9+
> - Star the project
10+
> - Tweet about it
11+
> - Refer this project in your project's readme
12+
> - Mention the project at local meetups and tell your friends/colleagues
13+
14+
## Table of Contents
15+
16+
- [Code of Conduct](#code-of-conduct)
17+
- [I Have a Question](#i-have-a-question)
18+
- [I Want To Contribute](#i-want-to-contribute)
19+
- [Reporting Bugs](#reporting-bugs)
20+
- [Suggesting Enhancements](#suggesting-enhancements)
21+
- [Your First Code Contribution](#your-first-code-contribution)
22+
- [Improving The Documentation](#improving-the-documentation)
23+
- [Styleguides](#styleguides)
24+
- [Commit Messages](#commit-messages)
25+
- [Join The Project Team](#join-the-project-team)
26+
27+
28+
## Code of Conduct
29+
30+
This project and everyone participating in it is governed by the
31+
[Meio Code of Conduct](https://github.com/nodeSoftwares/Meio/blob/main/CODE_OF_CONDUCT.md).
32+
By participating, you are expected to uphold this code. Please report unacceptable behavior
33+
to <@selkii:matrix.org or @can_i_get_some_burger:matrix.org>.
34+
35+
36+
## I Have a Question
37+
38+
> If you want to ask a question, we assume that you have read the available [Documentation]().
39+
40+
Before you ask a question, it is best to search for existing [Issues](https://github.com/nodeSoftwares/Meio/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
41+
42+
If you then still feel the need to ask a question and need clarification, we recommend the following:
43+
44+
- Open an [Issue](https://github.com/nodeSoftwares/Meio/issues/new).
45+
- Provide as much context as you can about what you're running into.
46+
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
47+
48+
We will then take care of the issue as soon as possible.
49+
## I Want To Contribute
50+
51+
### Legal Notice
52+
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
53+
54+
### Reporting Bugs
55+
56+
#### Before Submitting a Bug Report
57+
58+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
59+
60+
- Make sure that you are using the latest version.
61+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)).
62+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/nodeSoftwares/Meio/issues?q=label%3Abug).
63+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
64+
- Collect information about the bug:
65+
- Stack trace (Traceback)
66+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
67+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
68+
- Possibly your input and the output
69+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
70+
71+
#### Before Submitting an Enhancement
72+
73+
- Make sure that you are using the latest version.
74+
- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
75+
- Perform a [search](https://github.com/nodeSoftwares/Meio/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
76+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
77+
78+
#### How Do I Submit a Good Enhancement Suggestion?
79+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/nodeSoftwares/Meio/issues).
80+

0 commit comments

Comments
 (0)