-
Notifications
You must be signed in to change notification settings - Fork 726
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #846 from bragamat/chore/easify-getting-started-co…
…ntributing [CHORE] DX: easify getting started contributing
- Loading branch information
Showing
3 changed files
with
45 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
.DEFAULT_GOAL := test | ||
|
||
test: | ||
bundle exec rake test | ||
.PHONY: test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters