Skip to content

Commit 6b63b18

Browse files
committed
add 'how to contribute' in CONTRIBUTING.md
1 parent 12c7e29 commit 6b63b18

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing to `introprog-scalalib`
2+
3+
Contributions are welcome!
4+
5+
1. Open an **issue** and start discussing your suggestions. Issues can comprise e.g. a bug, a documentation improvement, a new or enhanced feature, beginner-friendly examples, tests, etc.
6+
7+
2. **Fork** this repo.
8+
9+
3. Do your changes and additions in line with the issue discussions. Make minimal, coherent commits with good commit messages.
10+
11+
4. When you are ready with an enhancement that compiles and run according to expectations, create a **pull request** (PR). Make sure your fork is up-to-date with the master repo before creating a PR.
12+
13+
Please keep the general intention of this repo in mind as outlined in the README; in summary: *Beginner-friendly API:s usable with simple Scala*
14+
15+
Further help on how to keep it simple:
16+
17+
* http://www.lihaoyi.com/post/StrategicScalaStylePrincipleofLeastPower.html

0 commit comments

Comments
 (0)