Skip to content

Commit

Permalink
Merge pull request #846 from bragamat/chore/easify-getting-started-co…
Browse files Browse the repository at this point in the history
…ntributing

[CHORE] DX: easify getting started contributing
  • Loading branch information
benlangfeld authored Nov 8, 2023
2 parents eb0ed26 + d17ae69 commit 743ae91
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 2 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
```
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.DEFAULT_GOAL := test

test:
bundle exec rake test
.PHONY: test
4 changes: 2 additions & 2 deletions whenever.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Gem::Specification.new do |s|

s.add_development_dependency "bundler"
s.add_development_dependency "rake"
s.add_development_dependency "mocha", ">= 0.9.5"
s.add_development_dependency "minitest"
s.add_development_dependency "mocha", ">= 0.9.5", "< 2.0.0"
s.add_development_dependency "minitest", "<= 5.2.0"
s.add_development_dependency "appraisal"
end

0 comments on commit 743ae91

Please sign in to comment.