Repository navigation
Story: Rename the GitHub repository and finalize spatial-encoder integration #27
Copy link
Copy link
Closed
Copy link
Description
Goal
Complete #19 by renaming the GitHub repository from longitude-one/spatial-writer to longitude-one/spatial-encoder and finalizing all repository-level documentation, automation, and integration under the new project identity.
Scope
Rename the GitHub repository:
longitude-one/spatial-writer → longitude-one/spatial-encoder
Preserve repository history, issues, pull requests, and relevant project configuration.
Finalize repository-level integration:
- Update GitHub Actions workflows and repository configuration affected by the rename.
- Update README content, badges, installation instructions, and usage examples.
- Update project documentation to use
spatial-encoder,longitude-one/spatial-encoder,LongitudeOne\SpatialEncoder,Encoder, andEncodeStrategyInterface. - Document the relationship between
spatial-encoder,spatial-decoder, andspatial-transformer. - Update repository/package references that still point to the former project identity.
- Verify Composer installation under the new package identity.
- Perform the final validation of the Epic.
Acceptance criteria
- The GitHub repository is named
longitude-one/spatial-encoder. - Repository history, issues, pull requests, and relevant configuration are preserved.
- Public documentation consistently identifies the project as
spatial-encoder. - README installation instructions use
longitude-one/spatial-encoder. - Public examples use
LongitudeOne\SpatialEncoder,Encoder,EncodeStrategyInterface, andencode(). - Documentation describes the immutable Strategy-based encoding architecture.
- Documentation describes the responsibilities of concrete encoding strategies and the supported output representations.
- Documentation describes the relationship with
spatial-decoderandspatial-transformer. - GitHub Actions execute successfully after the repository rename.
- Composer installation succeeds using the final package configuration.
- The complete test and quality pipelines succeed.
- A final repository-wide check finds no obsolete
spatial-writerreferences except historical references that are intentionally retained. - No backward-compatibility or deprecation mechanism for the former Writer API exists.
- All completion criteria of Epic: Rename spatial-writer to spatial-encoder and redesign the public API #19 are satisfied.
Final validation gate
The final state must pass the standard LongitudeOne validation pipeline, including Composer installation, the complete test suite, configured quality checks, and GitHub Actions.
Out of scope
- New encoding formats.
- Changes to existing encoding semantics.
- Decoding.
- Coordinate transformation or reprojection.
- Backward compatibility for
spatial-writer.
Parent Epic
Dependencies
Depends on completion of:
- the generic Encoder API Story;
- the package and PHP namespace rename Story.
Estimate
2 Story Points
Metadata
Metadata
Assignees
Labels
No labels
Activity
[-]Rename the GitHub repository and finalize spatial-encoder integration[/-][+]Story: Rename the GitHub repository and finalize spatial-encoder integration[/+]