Skip to content
This repository was archived by the owner on Sep 6, 2021. It is now read-only.

Commit 815e1dc

Browse files
Create CONTRIBUTING.md
1 parent 3d6ba1c commit 815e1dc

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing Guidelines
2+
3+
## Creating a good Pull request
4+
Try to make your code clean and readable.
5+
If not you can still create a Pull request.
6+
We will try to give you advice on how to improve your solution.
7+
8+
## Structuring your solution
9+
Please try to follow those rough guidelines:
10+
11+
For each day create a class.
12+
13+
- Example: The solution for day 5 should be called `Day5`
14+
15+
Each part should have its own Method and should be called in a main method.
16+
This improves the readability and its easier to understand how you solved the different parts.
17+
18+
- Rough example for day 5:
19+
20+
```java
21+
public class Day5 {
22+
public static void main(String[] args) {
23+
System.out.println("Solution for part one: " + partOne());
24+
System.out.println("Solution for part two: " + partTwo());
25+
}
26+
27+
public static int partOne() {
28+
// implements solution for part one
29+
}
30+
31+
public static int partTwo() {
32+
// implements solution for part two
33+
}
34+
35+
// Additional Methods needed for solutions above
36+
}
37+
```

0 commit comments

Comments
 (0)