Skip to content

577 add comprehensive instructions for khiops python development#580

Open
popescu-v wants to merge 2 commits into
mainfrom
577-add-comprehensive-instructions-for-khiops-python-development
Open

577 add comprehensive instructions for khiops python development#580
popescu-v wants to merge 2 commits into
mainfrom
577-add-comprehensive-instructions-for-khiops-python-development

Conversation

@popescu-v
Copy link
Copy Markdown
Collaborator

@popescu-v popescu-v commented May 19, 2026

closes #577


TODO Before Asking for a Review

  • Rebase your branch to the latest version of main (or main-v10)
  • Make sure all CI workflows are green This is moot for this kind of updates
  • When adding a public feature/fix: Update the Unreleased section of CHANGELOG.md (no date) This is irrelevant to dev chores
  • Self-Review: Review "Files Changed" tab and fix any problems you find
  • API Docs (only if there are changes in docstrings, rst files or samples):
    • Check the docs build without warning: see the log of the API Docs workflow
    • Check that your changes render well in HTML: download the API Docs artifact and open index.html
    • If there are any problems it is faster to iterate by building locally the API Docs

popescu-v added 2 commits May 19, 2026 15:19
- generic instruction file: .github/copilot-instructions.md
- instruction file specific to the CI workflows:
  .github/instructions/ci-workflows.instructions.md
- instruction file specific to the documentation generation:
  .github/instructions/doc-changes.instructions.md
- instruction file specific to the development Docker image maintenance:
  .github/instructions/docker-changes.instructions.md
- instruction file specific to the maintenance of the Python code itself:
  .github/instructions/python-changes.instructions.md
@popescu-v popescu-v linked an issue May 19, 2026 that may be closed by this pull request
@popescu-v popescu-v self-assigned this May 19, 2026
@popescu-v popescu-v requested a review from tramora May 19, 2026 13:28
(`.khj`, `.khcj`)
- `core.internals.runner` — backend abstraction for local, Docker, and other
execution modes, configurable with `get_runner()` and `set_runner()`
- `core.internals.filesystems` — filesystem abstraction for local, S3, and
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could add Azure too

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, will update this.

Copy link
Copy Markdown
Collaborator

@tramora tramora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For an human-being like me it seems very clear and comprehensive.

From the root copilot-instructions.md it is easy to follow and apply the corresponding sub instructions.

I'm wondering if it is required to give the workflow counts (7) and the current components versions that will require instructions changes later whenever they change

@popescu-v
Copy link
Copy Markdown
Collaborator Author

popescu-v commented May 22, 2026

I'm wondering if it is required to give the workflow counts (7) and the current components versions that will require instructions changes later whenever they change

Right, we could abstract these away.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Comprehensive Instructions for Khiops Python Development

2 participants