Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (30 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 1.63 KB
Raw

Contributing — OSLC 2020 Reference Implementation

Thanks for contributing! Please make sure to use latest SNAPSHOT versions of Lyo and Lyo Designer during development and testing of this repo.

Before you submit

  • Quick check (no Docker): cd src && mvn test.
  • Full acceptance suite (needs Docker): cd src && mvn clean verify -Pacceptance.
  • Keep DEVELOPMENT.md and AGENTS.md in sync whenever the test setup changes (the acceptance profile, Testcontainers / docker-compose.yml config, the server-rm *IT tests, etc.).
  • Keep DEVELOPMENT.md and CI configuration in sync when CI config changes significantly.

Updating docs

  • User-facing docs should go to the README.md
  • Dev-facing docs (useful for both devs and agents) should go to the DEVELOPMENT.md
  • Universal contribution docs go here (CONTRIBUTING.md)
  • Agent-specific docs go to AGENTS.md

Generated code — Lyo Designer guard blocks

Most Java source files under src/server-*/ are generated by Lyo Designer. The generator overwrites everything outside the guard comments on each regeneration:

// Start of user code <blockName>
// End of user code

Only modify code that sits between these two comments. Never change initialisation statements, method signatures, field declarations, imports, or any other generated boilerplate outside a // user code block — those changes will be silently lost the next time someone runs the generator.

If you need a new import required by your user-code changes, place it inside the // Start of user code imports … // End of user code block near the top of the file.