Skip to content

Commit cdd42bf

Browse files
committed
docs: Community health files
1 parent a621df7 commit cdd42bf

File tree

2 files changed

+66
-1
lines changed

2 files changed

+66
-1
lines changed

github/CODE_OF_CONDUCT.md renamed to .github/CODE_OF_CONDUCT.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# Contributor Covenant Code of Conduct
21

32
## Our Pledge
43

.github/CONTRIBUTING.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Contributing
2+
3+
By participating to this project, you agree to abide [code of conduct](https://github.com/obalunenko/advent-of-code/blob/master/.github/CODE_OF_CONDUCT.md).
4+
5+
Please note that I'll not accept any PR with new puzzle solutions - I don't like spoilers.
6+
7+
But if you have any idea how to improve the existing codebase - you are welcome to create a PR.
8+
9+
## Setup your machine
10+
11+
`advent-of-code` is written in [Go](https://golang.org/).
12+
13+
Prerequisites:
14+
15+
- [Go 1.17+](https://golang.org/doc/install)
16+
- make
17+
18+
Clone `advent-of-code` anywhere:
19+
20+
```sh
21+
git clone git@github.com:obalunenko/advent-of-code.git
22+
```
23+
24+
`cd` into the directory and install the dependencies:
25+
26+
```sh
27+
make install-tools
28+
```
29+
30+
A good way of making sure everything is all right is running the test suite:
31+
32+
```sh
33+
make test
34+
```
35+
36+
## Test your change
37+
38+
You can create a branch for your changes and try to build from the source as you go:
39+
40+
```sh
41+
make build
42+
```
43+
44+
When you are satisfied with the changes, we suggest you run:
45+
46+
```sh
47+
make test && make test-regression
48+
```
49+
50+
Before you commit the changes, we also suggest you run:
51+
52+
```sh
53+
make format-project
54+
```
55+
56+
## Create a commit
57+
58+
Commit messages should be well formatted, and to make that "standardized", we
59+
are using Conventional Commits.
60+
61+
You can follow the documentation on
62+
[their website](https://www.conventionalcommits.org).
63+
64+
## Submit a pull request
65+
66+
Push your branch to your `advent-of-code` fork and open a pull request against the main branch.

0 commit comments

Comments
 (0)