-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathCONTRIBUTING
More file actions
42 lines (28 loc) · 1.02 KB
/
CONTRIBUTING
File metadata and controls
42 lines (28 loc) · 1.02 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# Contributing
If you would like to contribute to this project, please follow these steps:
1. Fork the repository
2. Create a new branch (`git checkout -b feature/branch-name`)
3. Make changes
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin feature/branch-name`)
6. Create a Pull Request
## Testing
To run tests locally, just run the script `ci/run_testsuite_and_record_V2.sh` from anywhere. The only prerequisite is a working installation of docker or podman.
## Publishing
Publishing new versions is automatically handled by GitHub actions for versions tagged with `x.y.z[.prerelease]` (`1.2.3`, `1.2.3.rc1`, etc.). If you are a maintainer, you can create a new release by following these steps:
1. Switch to the `master` branch:
```bash
git checkout master
```
2. Create a new tag:
```bash
git tag 1.2.3
```
3. Push the tag to the upstream repository:
```bash
git push upstream 1.2.3
```
To push a tag together with a new commit:
```bash
git push upstream master --tags
```