Skip to content

Commit 1498f34

Browse files
committed
Update AGENTS.md
1 parent 59a2982 commit 1498f34

File tree

1 file changed

+9
-16
lines changed

1 file changed

+9
-16
lines changed

AGENTS.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@ The Lucee code base was forked from the Railo Server Project (Version 4.2) in Ja
1717

1818
## Build & Commands
1919

20-
- Build, in the `/loader` directory, execute `mvn fast`
21-
- Build and test, in the `/loader` directory, execute `mvn test`
22-
- Build and execute a specific CFML test suite in the `/loader` directory, execute `mvn test -DtestFilter="{testFilename}"`
20+
Always from the `/loader` directory and piping the output to a file
21+
22+
- Build and run specific test, execute `mvn test -DtestFilter="{testFilename}`
23+
- To just build, execute `mvn fast`
24+
- To build and run the whole test suite, execute `mvn test`
2325

2426
### Development Environment
2527

@@ -42,7 +44,8 @@ Lucee Ant Script Runner allows you to run Lucee CFML scripts headless (without a
4244
It is ideal for automation, testing, and running scripts with custom Lucee builds.
4345

4446
**Requirements:**
45-
- You must have a local copy of the [script-runner repository](https://github.com/lucee/script-runner) checked out.
47+
48+
- You need a local copy of the [script-runner repository](https://github.com/lucee/script-runner) checked out.
4649
If you do not have it, please clone it first.
4750
> **Tip:** The script-runner directory may already exist in the parent directory of this repo.
4851
@@ -61,7 +64,6 @@ The resulting JAR will be found in `loader/target` and its filename will include
6164
ant -buildfile "..\script-runner\build.xml" -DluceeJar="/full/pathot/loader/target/lucee-{version}.jar" -Dwebroot="D:\work\yourproject" -Dexecute="test.cfm"
6265
```
6366

64-
6567
- `-DluceeJar` being the full path to the built Lucee JAR in `loader/target`, use exact version and full path
6668
- `-Dwebroot` is your project directory.
6769
- `-Dexecute` is the script to run (relative to webroot).
@@ -70,15 +72,11 @@ See [script-runner README](https://github.com/lucee/script-runner/blob/main/READ
7072

7173
## Contribution Workflow
7274

73-
- Before starting work, consider filing a proposal on the mailing list.
74-
- File a ticket for your issue on JIRA, assuming one does not already exist.
75-
- Fork the repository on GitHub.
76-
- Create a feature branch off the appropriate version branch. `7.0` is the active development branch. `6.2` is the active stable branch. `5.4` is for LTS security fixes.
77-
- Create or update unit tests for your changes.
75+
- Create a feature branch off the appropriate version branch. `7.0` is the active stable branch. `6.2` is the active LTS branch.
76+
- Create or update unit tests for your changes, TDD, repo then fix/
7877
- Make sure your branch is rebased with the latest changes from the upstream repo before submitting.
7978
- Commit messages must include the ticket number, e.g., `LDEV-007 Add support to James Bond's watch for OSGI bundles`.
8079
- Include a link to the JIRA ticket in your pull request description.
81-
- All contributors must accept the LAS Contributor License Agreement (CLA).
8280

8381
### Documentation
8482

@@ -101,7 +99,6 @@ If your change affects a documented feature, please also submit a pull request t
10199
- Tests should cleanup after themselves and any temporary files should be created under the directory returned from `getTempDirectory()`
102100
- Test framework code, specifically files in the root of the `/test` directory should be compatible with Lucee 5.4, therefore, do not use newer cfml functionality.
103101

104-
105102
## Security
106103

107104
- Use appropriate data types that limit exposure of sensitive information
@@ -132,7 +129,3 @@ When updating a Java library
132129
- [Lucee Documentation](https://docs.lucee.org/)
133130
- [Lucee Mailing List / Forum](https://dev.lucee.org/)
134131
- [Lucee Bug Tracker](https://luceeserver.atlassian.net/)
135-
136-
## License
137-
138-
Lucee Server is licensed under the Lesser GNU General Public License Version 2.1 (or later).

0 commit comments

Comments
 (0)