Skip to content

Commit d06caef

Browse files
committed
Address code review comments for experimental.md
1 parent 43bcd5b commit d06caef

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/experimental.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
In addition to our standard CodeQL queries and libraries, this repository may also contain queries and libraries of a more experimental nature. Experimental queries and libraries can be improved incrementally and may eventually reach a sufficient maturity to be included in our standard libraries and queries.
44

5+
Experimental queries and libraries may not be actively maintained as the standard libraries evolve, may be changed in backwards-incompatible ways or may be removed entirely in the future without deprecation warnings.
6+
57
## Requirements
68

79
1. **Directory structure**
@@ -23,7 +25,7 @@ In addition to our standard CodeQL queries and libraries, this repository may al
2325

2426
4. **Compilation**
2527

26-
- Compilation of the query and any associated libraries and tests must be resilient to future development of the standard libraries. This means that the functionality cannot depend on the output of `getAQlClass` and it cannot use internal APIs.
28+
- Compilation of the query and any associated libraries and tests must be resilient to future development of the standard libraries. This means that the functionality cannot use internal APIs, cannot depend on the output of `getAQlClass` and cannot make use of regexp matching on `toString`.
2729
- The query and any associated libraries and tests must not cause any compiler warnings to be emitted (such as use of deprecated functionality or missing `override` annotations).
2830

2931
5. **Results**
@@ -38,5 +40,3 @@ In addition to our standard CodeQL queries and libraries, this repository may al
3840

3941
Other criteria typically required for our standard queries and libraries are not required for experimental queries and libraries. In particular, fully disciplined query [metadata](docs/query-metadata-style-guide.md), query [help](docs/query-help-style-guide.md), tests, a low false positive rate and performance tuning are not required (but nonetheless recommended).
4042

41-
Experimental queries and libraries may not be actively maintained as the standard libraries evolve and may be removed in the future.
42-

0 commit comments

Comments
 (0)