Skip to content

Commit 1ca324a

Browse files
committed
[ADDED] copilot-instructions.md
1 parent 5ae87dc commit 1ca324a

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

.github/copilot-instructions.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
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:
2+
3+
[//]: # (Source: https://docs.github.com/en/enterprise-cloud@latest/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks)
4+
5+
## Code Standards
6+
7+
### Pre-setup
8+
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.
9+
10+
### Development Flow
11+
- Build: `gradle build`
12+
- Test: `gradle check`
13+
14+
## Repository Structure
15+
- `lib` - Gradle module containing the core JSON5 library code with unit tests
16+
- `app` - Gradle module containing the application code that uses the JSON5 library
17+
- `benchmark` - Gradle module for performance benchmarks
18+
19+
## Key Guidelines
20+
1. Follow Kotlin best practices and idiomatic patterns
21+
2. Maintain existing code structure and organization
22+
3. Write unit tests for new functionality
23+
4. Update project README as needed to reflect changes

0 commit comments

Comments
 (0)