Skip to content

Commit 4f12a82

Browse files
svenvandescheurCharString
authored andcommitted
📝 docs: fix documentation
1 parent 8155543 commit 4f12a82

File tree

4 files changed

+19
-4
lines changed

4 files changed

+19
-4
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,15 @@ On your local machine, create a new branch, and name it like:
4747
Once you have made changes or additions to the code, you can commit them (try to keep the commit
4848
message descriptive but short). If an issue already exists in the list of existing [issues][issues]
4949
for the changes you made, be sure to format your commit message like
50-
`:gitmoji: Fixes #<issue_id> -- description of changes made`, where `<issue_id>` corresponds to the
51-
number of the issue on GitHub. To demonstrate that the changes implement the new feature/fix the
52-
issue, make sure to also add tests to the existing Django testsuite.
50+
`<gitmoji>[ <ticket>] <type>[(<scope>)]: <description>`, where:
51+
52+
- `<gitmoji>` [gitmoji](https://gitmoji.dev) describing the nature of the change.
53+
- `<ticket>` (optional for small changes) corresponds to the number of the issue on GitHub.
54+
- `<type>` The type of change, must be in the type list of the [Angular commit message guildelines](https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md#type).
55+
- `<scope>` (optional) corresponds to the number of the issue on GitHub.
56+
- `<description>` description of the change.
57+
To demonstrate that the changes implement the new feature/fix the issue, make sure to
58+
also add tests to the existing Django testsuite.
5359

5460
#### Refactoring
5561

README.NL.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ interface. (`English version`_)
1313

1414
Ontwikkeld door `Maykin B.V.`_, oorspronkelijk in opdracht van `Gemeente Rotterdam`_.
1515

16+
.. note::
17+
18+
⚠️ **Projectstatus:** Dit project is in actieve ontwikkeling.
19+
Bepaalde functionaliteiten zijn nog in aanbouw en kunnen wijzigen.
20+
1621

1722
Introductie
1823
===========

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ Easily create and publish smart forms (`Nederlandse versie`_)
1212

1313
Developed by `Maykin B.V.`_, originally commissioned by `Gemeente Rotterdam`_.
1414

15+
.. note::
16+
17+
⚠️ **Project status:** This project is under active development.
18+
Some functionality is still in progress and subject to change.
1519

1620
Introduction
1721
===========

frontend/commitlint.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ const config = {
6363
// Message did not match format.
6464
return [
6565
false,
66-
"Commit message format invalid: \n\nFormat: <gitmoji>[ [ticket]] <type>[([optional scope])]: <description>.\nExample: :sparkles: [#1] feat: implement new feature",
66+
"Commit message format invalid: \n\nFormat: <gitmoji>[ <ticket>] <type>[(<scope>)]: <description>.\nExample: :sparkles: [#1] feat: implement new feature",
6767
];
6868
},
6969
],

0 commit comments

Comments
 (0)