Skip to content

Commit ad0c52d

Browse files
committed
feat: add contributing
1 parent 7ad0fdf commit ad0c52d

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

CONTRIBUTING.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing to Chainloop Core
2+
3+
Chainloop Core maintainers welcome contributions from the community and first want to thank you for taking the time to contribute!
4+
5+
This project and everyone participating in it is governed by the [Code of Conduct](./CODE_OF_CONDUCT.md) before contributing. By participating, you are expected to uphold this code.
6+
7+
## I Have a Question
8+
9+
> If you want to ask a question, we assume that you have read the available [Documentation](https://docs.chainloop.dev).
10+
11+
Before you ask a question, it is best to search for existing [Issues](https://github.com/chainloop-dev/chainloop/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
12+
13+
If you then still feel the need to ask a question and need clarification, we recommend the following:
14+
15+
- Open an [Issue](https://github.com/chainloop-dev/chainloop/issues/new).
16+
- Provide as much context as you can about what you're running into.
17+
18+
We will then take care of the issue as soon as possible.
19+
20+
## Development
21+
22+
### Chainloop Components
23+
24+
- `app/controlplane`
25+
- `app/artifact-cas`
26+
- `app/cli`
27+
28+
See makefiles in those directories for more information
29+
30+
### Using Docker Compose
31+
32+
You can run the core services (controlplane and CAS) and associated dependencies (postgresql) by running
33+
34+
```
35+
docker compose up
36+
```
37+
38+
Then, the CLI can be run by doing
39+
40+
```
41+
docker compose run --rm cli
42+
```
43+
44+
Note that changes made in the source code are not reflected automatically in the running services, for that you'll need to perform a restart.
45+
46+
```
47+
docker compose restart -t0 controlplane
48+
# or
49+
docker compose restart -t0 cas
50+
```
51+
52+
### Locally
53+
54+
Prerequisites
55+
56+
- postgresql
57+
58+
Note: You can run the prerequisites by leveraging the provided docker-compose file i.e `docker compose up postgresql`
59+
60+
Then each project has a `make run` target that can be used

0 commit comments

Comments
 (0)