Skip to content

Commit b09ebe0

Browse files
committed
Switch to jsonc
1 parent 35568a6 commit b09ebe0

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

docs/CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ Thank you for considering making a contribution to DXT! Our goal is to make DXT
77

88
This guide aims to set clear expectations for everyone involved in our project, to make collaborating a smooth and enjoyable experience.
99

10-
# I have a question
10+
## I have a question
1111

1212
If you are within Department for Environment, Food & Rural Affairs, please primarily direct your questions to our Slack channel [#defra-forms-support](https://defra-digital-team.slack.com). Our team monitors this channel during working hours and will provide assistance.
1313

14-
# I want to request something
14+
## I want to request something
1515

16-
## Reporting bugs
16+
### Reporting bugs
1717

1818
Report bugs on the [#defra-forms-support](https://defra-digital-team.slack.com) slack channel. If you are not a member of Defra, [submit a GitHub issue](https://github.com/DEFRA/forms-engine-plugin/issues).
1919

@@ -36,11 +36,11 @@ If your bug is with the plugin, ensure you are running the plugin in a supported
3636
- An estimated timeframe for a resolution
3737
- An update once the issue is resolved
3838

39-
## Suggesting features
39+
### Suggesting features
4040

4141
Feature suggestions are welcomed from teams within Defra Group only. Our roadmap is continually updated as new requirements emerge. Suggest new features on our [#defra-forms-support](https://defra-digital-team.slack.com) slack channel.
4242

43-
# I want to contribute something
43+
## I want to contribute something
4444

4545
All code contributed to this repository should meet the [Defra software development standards](https://defra.github.io/software-development-standards/). Our codebase, by exception, allows modification of Typescript files where appropriate. However, new code that is contributed should be Javascript with types via JSDoc, not Typescript.
4646

@@ -50,10 +50,10 @@ Our GitHub Workflows will mark each pull request with a pass/fail based on tests
5050

5151
Draft pull requests are accepted if you are not yet finished, but would like early feedback. Pull requests that remain as a draft for over 30 days will be closed.
5252

53-
## Fixing bugs
53+
### Fixing bugs
5454

5555
If you would like to fix the bug yourself, contributions are accepted through pull requests.
5656

57-
## Adding features
57+
### Adding features
5858

5959
Features should be discussed with the Defra Forms team prior to implementation. This is to prevent wasted effort if the Defra Forms team decides not to accept it, or if we suggest any significant amendments. Reach out to us on [#defra-forms-support](https://defra-digital-team.slack.com) to discuss your requirements. If accepted by the product owner, we welcome a pull request.

docs/features/configuration-based/PAGE_EVENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,13 @@ DXT sends a standardised payload to each API configured with page events. The la
5757

5858
As of 2025-03-25, the payload would look something like this:
5959

60-
```json
60+
```jsonc
6161
{
6262
"meta": {
6363
"schemaVersion": "2",
6464
"timestamp": "2025-03-25T10:00:00Z",
6565
"definition": {
66-
"_comment": "This object would be a full copy of the form definition at the time of submission. It is excluded for brevity."
66+
// This object would be a full copy of the form definition at the time of submission. It is excluded for brevity.
6767
}
6868
},
6969
"data": {

0 commit comments

Comments
 (0)