From f59aaf200ec2aedb77a44a40bee5bb044ec38750 Mon Sep 17 00:00:00 2001
From: zamaz <71521611+zachariahmiller@users.noreply.github.com>
Date: Wed, 3 Jul 2024 14:27:06 -0400
Subject: [PATCH] docs: add readme note on ide configuration (#15)

## Description

add readme note on ide configuration

## Related Issue

Fixes #
<!-- or -->
Relates to #

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor Guide
Steps](https://github.com/defenseunicorns/uds-package-valkey/blob/main/CONTRIBUTING.md#developer-workflow)
followed
---
 .gitignore | 1 +
 README.md  | 4 ++++
 2 files changed, 5 insertions(+)

diff --git a/.gitignore b/.gitignore
index 702c2fb..95c4449 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,4 +4,5 @@ build/
 .DS_Store
 *.tar.zst
 zarf-sbom
+.vscode/
 tmp/
diff --git a/README.md b/README.md
index 1e03cf1..9d1bd48 100644
--- a/README.md
+++ b/README.md
@@ -38,3 +38,7 @@ After installing uds-cli, for a list of available tasks that can be run in this
 ## Contributing
 
 Please see the [CONTRIBUTING.md](./CONTRIBUTING.md)
+
+## Development
+
+When developing this package it is ideal to utilize the json schemas for UDS Bundles, Zarf Packages and Maru Tasks. This involves configuring your IDE to provide schema validation for the respective files used by each application. For guidance on how to set up this schema validation, please refer to the [guide](https://github.com/defenseunicorns/uds-common/blob/main/docs/development-ide-configuration.md) in uds-common.