Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sonus21 authored Jan 18, 2023
1 parent e9d60a0 commit 6e272ec
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[![Build Status](https://circleci.com/gh/sonus21/rqueue/tree/master.svg?style=shield)](https://circleci.com/gh/sonus21/rqueue/tree/master)
[![Coverage Status](https://coveralls.io/repos/github/sonus21/rqueue/badge.svg?branch=master)](https://coveralls.io/github/sonus21/rqueue?branch=master)
[![Maven Central](https://img.shields.io/maven-central/v/com.github.sonus21/rqueue-core)](https://repo1.maven.org/maven2/com/github/sonus21/rqueue-core)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)



## How to contribute to Rqueue

#### **Did you find a bug?**

* **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).

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/sonus21/rqueue/issues).

* 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.

* 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

#### **Did you write a patch that fixes a bug?**

* Open a new GitHub pull request with the patch.

* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.


#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**

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.

#### **Do you intend to add a new feature or change an existing one?**

* Breaking changes are not allowed generally
* You're welcome for any pull rqueuest for any new features.


Thanks! :heart: :heart: :heart:

0 comments on commit 6e272ec

Please sign in to comment.