Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -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