From 1ca324abec1240baac698e3dd3a4273661301b66 Mon Sep 17 00:00:00 2001 From: Hossain Khan Date: Mon, 9 Jun 2025 01:17:15 -0400 Subject: [PATCH] [ADDED] `copilot-instructions.md` --- .github/copilot-instructions.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/copilot-instructions.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000..06134e5 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,23 @@ +This is a Kotlin based repository with a JSON5 library for parsing and serializing JSON5 data. It is primarily responsible for handling configuration files and data interchange. Please follow these guidelines when contributing: + +[//]: # (Source: https://docs.github.com/en/enterprise-cloud@latest/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks) + +## Code Standards + +### Pre-setup +Do not try to use the `./gradlew` script to run the project. Instead, use `gradle` binary directly. Use the latest Gradle version compatible with the project. + +### Development Flow +- Build: `gradle build` +- Test: `gradle check` + +## Repository Structure +- `lib` - Gradle module containing the core JSON5 library code with unit tests +- `app` - Gradle module containing the application code that uses the JSON5 library +- `benchmark` - Gradle module for performance benchmarks + +## Key Guidelines +1. Follow Kotlin best practices and idiomatic patterns +2. Maintain existing code structure and organization +3. Write unit tests for new functionality +4. Update project README as needed to reflect changes \ No newline at end of file