Skip to content

Commit e33ab97

Browse files
committed
docs: add CONTRIBUTING.md
1 parent c70717d commit e33ab97

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

CONTRIBUTING.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contributing
2+
3+
Every contribution is welcome!
4+
5+
By contributing to this project, you agree to the [Contributor License Agreement (CLA)](https://cla-assistant.io/cdviz-dev/transformers-community).
6+
7+
## How to contribute
8+
9+
### Reporting bugs
10+
11+
If you found a bug, please open an [issue].
12+
13+
### Suggesting enhancements
14+
15+
If you have an idea for an enhancement, please open an [issue].
16+
17+
### Contributing documentation
18+
19+
If you want to contribute documentation, please open a pull request, and start a discussion on the PR.
20+
21+
### Contributing code
22+
23+
If you want to contribute code, please open an [issue] first to discuss what you want to do. Do not open a new [issue] to work on an existing [issue]. Then fork the repository, create a branch, and open a pull request.
24+
25+
1. Fork the repository.
26+
2. Create a branch for your changes.
27+
3. Commit with `git commit -s` to sign off your work.
28+
4. Submit a pull request.
29+
30+
All contributions must include a `Signed-off-by` line.
31+
32+
## How to build
33+
34+
The repository is composed of multiple subfolders / modules.
35+
36+
### Prerequisites
37+
38+
- [mise-en-place](https://mise.jdx.dev/) to download tools, setup local environment (tools, environment variables) and to run the tasks
39+
- [docker](https://docs.docker.com/get-started/) to run the containers and to execute some tests.
40+
To build the container locally you have to configure the container image store
41+
(see [Multi-platform | Docker Docs](https://docs.docker.com/build/building/multi-platform/#prerequisites)
42+
& [containerd image store | Docker Docs](https://docs.docker.com/engine/storage/containerd/))
43+
44+
### Build
45+
46+
```bash
47+
mise install
48+
49+
# to have list of tasks
50+
mise tasks
51+
52+
# to run a task
53+
mise run {{task}}
54+
55+
# to run the CI tasks
56+
mise run ci
57+
```
58+
59+
## How to test
60+
61+
```bash
62+
mise run test
63+
```
64+
65+
## How to release
66+
67+
???
68+
69+
[issue]: https://github.com/cdviz-dev/cdviz-collector/issues "CDviz collector's issue tracker"

0 commit comments

Comments
 (0)