Skip to content

Commit 5c29cf9

Browse files
author
Sergey D
authored
Create contributing.md
1 parent 25369ae commit 5c29cf9

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

.github/contributing.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
## How to contribute to Persei
2+
3+
#### **Did you find a bug?**
4+
5+
* **Ensure the bug was not already reported** by searching under [Issues](https://github.com/Yalantis/Persei/issues).
6+
7+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Yalantis/Persei/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **example project** demonstrating the expected behavior that is not occurring.
8+
9+
* Fill appropriate section in issue template and remove the section you aren't interested in.
10+
11+
#### **Did you write a patch that fixes a bug?**
12+
13+
* Open a new GitHub pull request with the patch.
14+
15+
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
16+
17+
* Ensure the PR doesn't extend the number of existing issues.
18+
19+
#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**
20+
21+
* Changes that are **cosmetic** in nature and **do not add anything substantial** to the stability or functionality of Persei will generally **not be accepted**.
22+
23+
#### **Did you write patch that extends functionality?**
24+
25+
* Ensure the functionality you trying to add needed not only for your case.
26+
27+
#### Each issue will be labeled by it's `type`, `priority` and `status`.
28+
29+
**Issue types:**
30+
* Bug
31+
* Enhancement
32+
33+
**These are the available priority labels:**
34+
* Critical
35+
* High
36+
* Medium
37+
* Low
38+
39+
**Status label will be assigned to your issue to keep the issue tracker easy to follow:**
40+
* Queued (will be reviewed soon)
41+
* Reviewed (assignee has read it)
42+
* Pending (will work on it soon)
43+
* Work in progress (is working on it now)
44+
* On hold
45+
* Invalid (if bug it's not reproducible)
46+
* Need feedback (signal to get people to read and comment or provide help)
47+
48+
#### **Coding Style**
49+
50+
* Most importantly, match the existing code style as much as possible.
51+
52+
#### **Do you have a question?**
53+
54+
For any usage questions that are not specific to the project itself, please ask on [Stack Overflow](https://stackoverflow.com/). By doing so, you'll be more likely to quickly solve your problem, and you'll allow anyone else with the same question to find the answer. This also allows maintainers to focus on improving the project for others.
55+
56+
## Thank you!
57+
58+
#### [![Yalantis](https://raw.githubusercontent.com/Yalantis/PullToMakeSoup/master/PullToMakeSoupDemo/Resouces/badge_dark.png)](https://Yalantis.com/?utm_source=github)

0 commit comments

Comments
 (0)