Documentation and templates

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,51 @@
+<!--
+  Thank you for reporting a bug to DXT! Please follow the instructions in the comment tags.
+  Unless you have been instructed, do not delete any text in this template.
+-->
+
+# Describe the bug
+
+A clear and concise description of what the bug is.
+
+# Steps to reproduce
+
+<!--
+  This should be a step-by-step guide on how to replicate your issue. Be as detailed as you can.
+  Please upload your form definition JSON to this issue, if appropriate.
+-->
+
+Steps to reproduce the behavior, e.g.:
+
+1. Create a form containing '...'
+2. Navigate to the '....' page
+3. Click on '....' or type in '....'
+4. See error
+
+# Expected behaviour
+
+A clear and concise description of what you expected to happen.
+
+# Environment
+
+## Desktop (please complete the following information)
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+## Smartphone (please complete the following information):
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+# Checklist
+
+<!--
+  Mark each completed item with an X, e.g. "[X] You have....".
+-->
+
+- [] You have verified this is affecting the latest version of `@defra/forms-engine-plugin` or the production version of our service `https://forms-designer.prod.cdp-int.defra.cloud/`
+- [] You have filled out the required sections above
+- [] You have uploaded a copy of your JSON form definition to this issue

docs/CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing to DXT
+
+> [!NOTE]
+> This guide is for developers within the Department for Environment, Food & Rural Affairs. We do not guarantee support for those outside of this organisation.
+
+Thank you for considering making a contribution to DXT! Our goal is to make DXT a community-driven effort, collaboratively supporting the needs of the many teams within the Defra Group.
+
+This guide aims to set clear expectations for everyone involved in our project, to make collaborating a smooth and enjoyable experience.
+
+# I have a question
+
+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.
+
+# I want to request something
+
+## Reporting bugs
+
+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).
+
+Ensure you are experiencing it with the latest version of `@defra/forms-engine-plugin` or the production version of our service `https://forms-designer.prod.cdp-int.defra.cloud/`. Support for older versions is not currently provided.
+
+If your bug is with the plugin, ensure you are running the plugin in a supported environment: see `package.json` to validate the compatible Node runtime and `README.md` to validate runtime dependencies.
+
+**What we need from you:**
+
+- A short and clear description of the issue. Explain the current behaviour along with the expected behaviour.
+- A step-by-step guide that details how we can reproduce your issue
+- A text copy (not a screenshot) of any error messages and stack traces
+- The version of your runtime (e.g. Node 22.11.0)
+- If the issue is with a form, a copy of the form definition (JSON) file
+
+**What we will provide:**
+
+- An acknowledgement of your issue
+- A Azure DevOps ticket number, where any remediation work will be tracked
+- An estimated timeframe for a resolution
+- An update once the issue is resolved
+
+## Suggesting features
+
+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.
+
+# I want to contribute something
+
+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.
+
+Our specific coding standards are primarily enforced by our GitHub workflows. These workflows will verify using tsc, ESLint, Prettier, EditorConfig and Stylelint. See the `lint` job within [.github/workflows/check-pull-request.yml](.github/workflows/check-pull-request.yml) for more details.
+
+Our GitHub Workflows will mark each pull request with a pass/fail based on tests, linting, type checking and analysis by SonarQube. **Pull requests that fail these checks will not be accepted.**
+
+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.
+
+## Fixing bugs
+
+If you would like to fix the bug yourself, contributions are accepted through pull requests.
+
+## Adding features
+
+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/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,45 @@
+<!--
+  Thank you for contributing to DXT! Please follow the instructions in the comment tags.
+  Unless you have been instructed, do not delete any text in this template.
+-->
+
+## Proposed change
+
+<!--
+  Give a high-level description of the content of this pull request. No more than a couple of sentences.
+
+  If you have consulted with the Defra Forms team prior to implementation, they will have provided you with an Azure DevOps work item number or (preferably) a link. Please include this.
+-->
+
+Azure DevOps work item:
+
+## Type of change
+
+<!--
+  What type of change is this pull request? Mark the option with an X inside the brackets.
+  If your change covers multiple categories, please split the pull request up to make it easier to review.
+-->
+
+- [] Bug fix
+- [] New feature
+- [] Breaking change
+- [] Misc. (documentation, build updates, etc)
+
+## Checklist
+
+<!--
+  Mark each completed item with an X, e.g. "[X] You have....".
+  Feel free to chat to us on Slack if you have any questions.
+
+  If you have not completed all of this, you are welcome to submit your pull request in a draft state
+  to give us visibility and gather early feedback until it is ready for review.
+-->
+
+- [] You have executed this code locally and it performs as expected.
+- [] You have added tests to verify your code works.
+- [] You have added code comments and JSDoc, where appropriate.
+- [] There is no commented-out code.
+- [] You have added developer docs in `README.md` and `docs/*` (where appropriate, e.g. new features).
+- [] The tests are passing (`npm run test`).
+- [] The linting checks are passing (`npm run lint`).
+- [] The code has been formatted (`npm run format`).