Skip to content

Commit

Permalink
chore: adds contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
bragamat committed Nov 8, 2023
1 parent 319db28 commit d17ae69
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## How to contribute to Whenever

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

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

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/your/whenever/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.

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


#### **Do you have questions about the source code?**

* Ask any question about how to use Whenever in the [whenever issues](https://github.com/javan/whenever/issues).

#### **Do you want to contribute to the Whenever documentation?**

Whenever is a volunteer effort. We encourage you to pitch in!

Thanks! :heart: :heart: :heart:

Whenever Team

---
## Setup

```bash
$ bundle install
```
## Run tests

```bash
$ make test
```

0 comments on commit d17ae69

Please sign in to comment.