Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@

This repo follows a standard fork and pull model for contributions via GitHub pull requests. Thus, the contributing process looks as follows:

0. [Pick an issue](#pick-an-issue)
1. [Write code](#write-code)
2. [Write tests](#write-tests)
3. [Write docs](#write-docs)
4. [Submit a PR](#submit-a-pr)

# Pick an issue

* Set yourself as assignee
* On Github, leave a comment on the issue you picked to notify others that the issues is taken

# Write Code

We use [WartRemover](http://www.wartremover.org/doc/warts.html) for linting and [Scalafmt](http://scalameta.org/scalafmt/) for formatting.
Please run `scalafmt`command before committing. CI will fail on any formatting issue.

# Write Tests

TODO: Add tests + define test conventions

# Submit a PR

- PR should be submitted from a separate branch (use `git checkout -b task/adding-awesome-feature`)
- Use the following nomenclature for branch name:
- for a fix: `fix/quick-description`
- for a task: `task/quick-description`
- PR's commit message should use present tense
- PR worflow with github labels:
- `WIP`: more work need to be done on the PR (can be used to collaborate)
- `requires-review`: to ask for review
- `requires-changes`: some changes need to be done on the PR
- `merge-ready`: PR can be merged (at least one approve review + CI OK + no conflicts + up to date with master)
- PR should generally contain only one commit (use git commit --amend and git --force push or squash existing commits into one)
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@

### Operating System (Ubuntu 15.10 / MacOS 10.10 / Windows 10)

Use `uname -a` if on Linux.

### JDK (Oracle 1.8.0_72, OpenJDK 1.8.x, Azul Zing)

Paste the output from `java -version` at the command line.

### Library Dependencies

If this is an issue that involves integration with another system, include the exact version and OS of the other system, including any intermediate drivers or APIs i.e. if you connect to a PostgreSQL database, include both the version / OS of PostgreSQL and the JDBC driver version used to connect to the database.

### Expected Behavior

Please describe the expected behavior of the issue, starting from the first action.

1.
2.
3.

### Actual Behavior

Please provide a description of what actually happens, working from the same starting point.

Be descriptive: "it doesn't work" does not describe what the behavior actually is -- instead, say "an exception occured when executing a query." Copy and paste logs.

1.
2.
3.

### Reproducible Test Case

Please provide a PR with a failing test.

If the issue is more complex or requires configuration, please provide a link to a project on Github that reproduces the issue.
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Pull Request Checklist

* [ ] Have you read through the [contributor guide](CONTRIBUTING.md)?
* [ ] Have you added tests for any changed functionality?

## Fixes

Fixes #xxxx

## Purpose

What does this PR do?

## Background Context

Why did you take this approach?

## References

Are there any relevant issues / PRs ?
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# query-monad-example

Project for the article **Functional database programming with Play Anorm through the `Reader Monad`**

# CONTRIBUTING

Please take a look at the [Contribution guide](.github/CONTRIBUTING.md)