Skip to content

Commit 6e272ec

Browse files
authored
Create CONTRIBUTING.md
1 parent e9d60a0 commit 6e272ec

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
[![Build Status](https://circleci.com/gh/sonus21/rqueue/tree/master.svg?style=shield)](https://circleci.com/gh/sonus21/rqueue/tree/master)
2+
[![Coverage Status](https://coveralls.io/repos/github/sonus21/rqueue/badge.svg?branch=master)](https://coveralls.io/github/sonus21/rqueue?branch=master)
3+
[![Maven Central](https://img.shields.io/maven-central/v/com.github.sonus21/rqueue-core)](https://repo1.maven.org/maven2/com/github/sonus21/rqueue-core)
4+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
5+
6+
7+
8+
## How to contribute to Rqueue
9+
10+
#### **Did you find a bug?**
11+
12+
* **Do not open up a GitHub issue if the bug is a security vulnerability in Rqueue**, and instead to refer to our [security policy](https://github.com/sonus21/rqueue/blob/master/SECURITY.md).
13+
14+
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/sonus21/rqueue/issues).
15+
16+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/sonus21/rqueue/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
17+
18+
* If possible, use the relevant bug report [templates](https://github.com/sonus21/rqueue/issues/new?assignees=sonus21&labels=&template=bug-report.md&title=) to create the issue
19+
20+
#### **Did you write a patch that fixes a bug?**
21+
22+
* Open a new GitHub pull request with the patch.
23+
24+
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
25+
26+
27+
#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**
28+
29+
Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Rqueue will generally not be accepted.
30+
31+
#### **Do you intend to add a new feature or change an existing one?**
32+
33+
* Breaking changes are not allowed generally
34+
* You're welcome for any pull rqueuest for any new features.
35+
36+
37+
Thanks! :heart: :heart: :heart:

0 commit comments

Comments
 (0)