Skip to content

Commit 8635b66

Browse files
committed
simple start for some AI hints
1 parent 36a59a2 commit 8635b66

2 files changed

Lines changed: 35 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# htmlunit-xpath
2+
3+
This repository contains the XPath support library used by HtmlUnit. It's a Java library that provides XPath functionality for querying and navigating XML/HTML documents.
4+
The project was forked from Apache Xalan, which discontinued development in 2019. Since HtmlUnit only requires XPath functionality, this fork removes unnecessary components, updates the code for modern Java (JDK 8+), and adds comprehensive unit tests with a Maven-based build system.
5+
6+
This project is licensed under Apache License 2.0. Always include the appropriate Apache 2.0 license header in all new files.
7+
8+
9+
## Tech Stack
10+
11+
Language: Java 17+ (version 5.x will require JDK 17)
12+
Build Tool: Maven
13+
Testing: JUnit
14+
Code Quality: Checkstyle, PMD, SpotBugs
15+
CI/CD: Jenkins
16+
17+
## Useful commands
18+
19+
1. Build: `./mvn package`
20+
2. Run tests: `./mvn test`
21+
4. Checks (tests, formatting): `./mvn check`
22+
23+
## Rules and code style
24+
25+
- Follow the Checkstyle rules defined in checkstyle.xml
26+
- Use 4 spaces for indentation (no tabs)
27+
- Maximum line length: check checkstyle.xml for current limit
28+
- Follow Java naming conventions strictly
29+
- All public methods and classes must have Javadoc comments
30+
- Be restrained in regard to writing code comments.
31+
- Always add unit tests for any new feature or bug fixes. They should go either in `rhino` or `tests`; search for
32+
existing tests to make a decision on a case-by-case basis.
33+
- New test classes should be written using JUnit 5.
34+
- Code style is enforced via checkstyle. After every change, make sure there are no checkstyle validations.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

0 commit comments

Comments
 (0)