gooddata-python-sdk/.cursor/rules/guides/shared/commits.mdc at 169bd5802b02cbca4f1774ff0cd51a4b4fa7870b · gooddata/gooddata-python-sdk · GitHub

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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# (C) 2025 GoodData Corporation
---
description: Git commit conventions - conventional commits format
alwaysApply: false
---

# Commit Conventions

Commits must follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) specification.

## Format

```
<type>(<scope>): <description>

<body>

jira: <ticket-number>
risk: <risk-flag>
```

## Type

Must be one of:
- `feat` - A new feature
- `fix` - A bug fix
- `build` - Changes to build system or dependencies
- `ci` - Changes to CI configuration
- `docs` - Documentation changes
- `perf` - Performance improvements
- `style` - Formatting changes (no code change)
- `refactor` - Code change that neither fixes a bug nor adds a feature
- `test` - Adding or correcting tests
- `chore` - Other changes that don't modify src or test files
- `revert` - Revert previous changes

## Scope

Optional. The affected package name (e.g., `gooddata-sdk`, `gooddata-pandas`, `gooddata-dbt`).

## Description

- Max 50 characters (full line ≤ 70 chars)
- Lowercase, imperative mood
- No period at end

## Body

Optional detailed explanation. Wrap lines at 72 characters.

## Footer (Required)

- `jira: PROJECT-ID` or `jira: trivial` for minor changes
- `risk: nonprod|low|high`

## Example

```
feat(gooddata-sdk): add workspace permission methods

Add new methods to catalog_permission service for managing
workspace-level permissions programmatically.

jira: RAIL-12345
risk: low
```

## Dependencies

Related: general/general