Skip to content

Commit ac1589d

Browse files
authored
Init contribution guide (#7)
* Init contribution guide * Add github templates
1 parent 9b21625 commit ac1589d

File tree

4 files changed

+96
-0
lines changed

4 files changed

+96
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
This repo follows a standard fork and pull model for contributions via GitHub pull requests. Thus, the contributing process looks as follows:
3+
4+
0. [Pick an issue](#pick-an-issue)
5+
1. [Write code](#write-code)
6+
2. [Write tests](#write-tests)
7+
3. [Write docs](#write-docs)
8+
4. [Submit a PR](#submit-a-pr)
9+
10+
# Pick an issue
11+
12+
* Set yourself as assignee
13+
* On Github, leave a comment on the issue you picked to notify others that the issues is taken
14+
15+
# Write Code
16+
17+
We use [WartRemover](http://www.wartremover.org/doc/warts.html) for linting and [Scalafmt](http://scalameta.org/scalafmt/) for formatting.
18+
Please run `scalafmt`command before committing. CI will fail on any formatting issue.
19+
20+
# Write Tests
21+
22+
TODO: Add tests + define test conventions
23+
24+
# Submit a PR
25+
26+
- PR should be submitted from a separate branch (use `git checkout -b task/adding-awesome-feature`)
27+
- Use the following nomenclature for branch name:
28+
- for a fix: `fix/quick-description`
29+
- for a task: `task/quick-description`
30+
- PR's commit message should use present tense
31+
- PR worflow with github labels:
32+
- `WIP`: more work need to be done on the PR (can be used to collaborate)
33+
- `requires-review`: to ask for review
34+
- `requires-changes`: some changes need to be done on the PR
35+
- `merge-ready`: PR can be merged (at least one approve review + CI OK + no conflicts + up to date with master)
36+
- PR should generally contain only one commit (use git commit --amend and git --force push or squash existing commits into one)

.github/ISSUE_TEMPLATE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
### Operating System (Ubuntu 15.10 / MacOS 10.10 / Windows 10)
3+
4+
Use `uname -a` if on Linux.
5+
6+
### JDK (Oracle 1.8.0_72, OpenJDK 1.8.x, Azul Zing)
7+
8+
Paste the output from `java -version` at the command line.
9+
10+
### Library Dependencies
11+
12+
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.
13+
14+
### Expected Behavior
15+
16+
Please describe the expected behavior of the issue, starting from the first action.
17+
18+
1.
19+
2.
20+
3.
21+
22+
### Actual Behavior
23+
24+
Please provide a description of what actually happens, working from the same starting point.
25+
26+
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.
27+
28+
1.
29+
2.
30+
3.
31+
32+
### Reproducible Test Case
33+
34+
Please provide a PR with a failing test.
35+
36+
If the issue is more complex or requires configuration, please provide a link to a project on Github that reproduces the issue.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Pull Request Checklist
2+
3+
* [ ] Have you read through the [contributor guide](CONTRIBUTING.md)?
4+
* [ ] Have you added tests for any changed functionality?
5+
6+
## Fixes
7+
8+
Fixes #xxxx
9+
10+
## Purpose
11+
12+
What does this PR do?
13+
14+
## Background Context
15+
16+
Why did you take this approach?
17+
18+
## References
19+
20+
Are there any relevant issues / PRs ?

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# query-monad-example
22

33
Project for the article **Functional database programming with Play Anorm through the `Reader Monad`**
4+
5+
# CONTRIBUTING
6+
7+
Please take a look at the [Contribution guide](.github/CONTRIBUTING.md)

0 commit comments

Comments
 (0)