You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+25-21Lines changed: 25 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,14 @@ Welcome to the MetaConfigurator project! We appreciate your interest in contribu
4
4
5
5
---
6
6
7
-
## Team Members (with repository access)
7
+
## Branching Model
8
+
9
+
-**`develop`** — the default branch. All feature branches are created from here and all PRs target here.
10
+
-**`main`** — stable releases only. Updated manually by a maintainer when a set of changes is deemed stable, together with a version bump and changelog entry.
11
+
12
+
---
8
13
9
-
If you are part of the core team and have direct write access to the repository, follow this workflow:
14
+
## Team Members (with repository access)
10
15
11
16
### 1. Start with a GitHub Issue
12
17
@@ -16,7 +21,7 @@ If no issue exists yet, create one. If one exists, assign yourself to it or ask
16
21
### 2. Create a Branch from the Issue
17
22
18
23
Create a branch directly from the GitHub issue (using the "Create a branch" link on the issue page).
19
-
This automatically links the branch to the issue.
24
+
This automatically links the branch to the issue and bases it on `develop`.
20
25
Branch names follow the pattern `<issue-number>-short-description`, e.g. `123-add-searchbar`.
21
26
22
27
### 3. Develop Locally
@@ -32,15 +37,13 @@ See [documentation_developer/README.md](documentation_developer/README.md) for s
32
37
33
38
### 4. Open a Pull Request
34
39
35
-
When the work is complete, open a Pull Request and request a review.
40
+
When the work is complete, open a Pull Request targeting `develop`and request a review.
36
41
You can optionally open a **Draft Pull Request** earlier during development — this lets others follow along and give early feedback without a formal review being requested.
Never work directly on `main`. Create a branch for your change:
69
+
Never work directly on `develop` or `main`. Create a branch from `develop`:
67
70
68
71
```sh
72
+
git checkout develop
69
73
git checkout -b <issue-number>-short-description
70
74
```
71
75
72
76
### 4. Open a Pull Request
73
77
74
-
When your work is complete, open a Pull Request against the upstream `main` branch and request a review.
78
+
When your work is complete, open a Pull Request against the upstream `develop` branch and request a review.
75
79
You can optionally open a **Draft Pull Request** earlier during development to get early feedback from maintainers.
76
80
77
81
---
78
82
83
+
## Commit Messages
84
+
85
+
No specific format is enforced, but commit messages should start with a verb and clearly describe what was done — e.g. `Add validation for empty schema`. This helps reviewers follow your work in the PR.
86
+
87
+
---
88
+
79
89
## Pull Request Guidelines
80
90
81
-
-**Title:**Must follow the [Conventional Commits](https://www.conventionalcommits.org/) format — `<type>: <Verb> <subject>`— e.g. `feat: Add searchbar component`. This is required because the PR title is used as the squash merge commit message on `main`, from which the CI/CD pipeline automatically determines the semantic version bump and creates a release tag.
91
+
-**Title:**Start with a verb and describe what was done — e.g. `Add searchbar component`.
82
92
-**Description:** Always explain **why** the change is needed, not just what was changed. Link the related issue.
83
93
-**Scope:** Keep PRs focused on a single concern. Smaller PRs are reviewed faster and merged sooner.
84
94
-**Discussion:** PRs are the primary place for code review discussion. Use inline comments and the general PR thread to ask questions and suggest improvements.
85
95
86
-
**PR title type prefixes and their effect on versioning:**
96
+
---
87
97
88
-
| Prefix | Description | Version bump |
89
-
|---|---|---|
90
-
|`feat:`| A new feature | Minor (`x.Y.0`) |
91
-
|`fix:`| A bug fix | Patch (`x.y.Z`) |
92
-
|`perf:`| A performance improvement | Patch |
93
-
|`refactor:`| Code restructuring without behavior change | Patch |
|`breaking:`| Incompatible API change | Major (`X.0.0`) |
98
+
## Releases
98
99
99
-
PRs are always merged via **squash merge**, so the PR title becomes the single commit message on `main`. Individual commit messages on your branch are not required to follow the Conventional Commits format, but should still start with a verb and clearly describe what was done, e.g. `Add validation for empty schema` — this helps reviewers follow your work in the PR.
100
+
Releases are managed manually by maintainers. When a set of changes on `develop` is deemed stable, a maintainer will:
101
+
1. Update the version in `meta_configurator/package.json`
0 commit comments