Skip to content

Update README to include note about upcoming project template - #5

Merged
C-Achard merged 1 commit into
mainfrom
readme-template-upcoming
Nov 4, 2026
Merged

C-Achard merged 1 commit into
mainfrom
readme-template-upcoming

Conversation

@C-Achard

@C-Achard C-Achard commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@C-Achard C-Achard self-assigned this Nov 4, 2026
@C-Achard C-Achard added the documentation Improvements or additions to documentation label Nov 4, 2026
@C-Achard
C-Achard merged commit 638c36b into main Nov 4, 2026
6 checks passed
C-Achard added a commit that referenced this pull request Nov 4, 2026
C-Achard added a commit that referenced this pull request Nov 4, 2026
* Update documentation assets and structure for SCENE template

* nitialize scene_repo_template project structure and CLI

- Added __init__.py and version.py for package versioning.
- Implemented CLI in cli.py for creating new SCENE projects.
- Included skeleton files for common project structure, including LICENSE, README, and pyproject.toml templates.
- Set up GitHub Actions workflows for linting and testing.
- Created Jupyter Book documentation structure with templates.
- Updated tests to reflect new package name and structure.
- Added questionary dependency for interactive CLI prompts.

* Update CI test workflow and add end-to-end tests for project generation

* Refine README and documentation for clarity; update TODO and CLI comments

* Enhance validation for project names and add tests for edge cases

* Add dev tool name validation and enhance version test coverage

* Enhance validation for distribution names and GitHub URLs in CLI; add corresponding tests

* Update references from "Guidelines" to "Project standards" in documentation

* Revert "Update README to include note about upcoming project template (#5)"

This reverts commit 638c36b.

* Update documentation and enhance CLI interaction

- Clarify license synchronization steps in documentation.
- Improve error handling and user prompts in CLI for better interactivity.
- Update output messages to include direct links to the template guide.
- Add tests for interactive CLI behavior and validation of user inputs.

* Improve Jupyter Book documentation for page addition and configuration clarity
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant