Skip to content

577 add comprehensive instructions for khiops python development#580

Merged
popescu-v merged 3 commits into
mainfrom
577-add-comprehensive-instructions-for-khiops-python-development
May 29, 2026
Merged

577 add comprehensive instructions for khiops python development#580
popescu-v merged 3 commits into
mainfrom
577-add-comprehensive-instructions-for-khiops-python-development

Conversation

@popescu-v

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

Copy link
Copy Markdown
Collaborator

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 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
Comment thread .github/copilot-instructions.md Outdated

@tramora tramora left a comment

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.

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

popescu-v commented May 22, 2026

Copy link
Copy Markdown
Collaborator Author

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.

@popescu-v popescu-v force-pushed the 577-add-comprehensive-instructions-for-khiops-python-development branch from 02411ce to 6e4e0ce Compare May 29, 2026 08:37
@popescu-v

Copy link
Copy Markdown
Collaborator Author

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.

On second thought:

  • the component versions are just examples (stated as such)
  • the release.ymlworkflow has been opportunistically dropped: never used, not up-to-date.

@popescu-v popescu-v requested a review from tramora May 29, 2026 09:45

@tramora tramora left a comment

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.

The current status of the instructions is fine for me. There is a fear though about a little repetition regarding the Python code formatting and dependencies within the Python code but it is not blocking.
All these instructions will have to be refreshed soon for the very next Pull Requests

Comment thread .github/instructions/python-changes.instructions.md
Comment thread .github/instructions/python-changes.instructions.md
@tramora

tramora commented May 29, 2026

Copy link
Copy Markdown
Collaborator

I was surprised that the github workflows run after the instructions update. It was not the case the first time.

@popescu-v

Copy link
Copy Markdown
Collaborator Author

I was surprised that the github workflows run after the instructions update. It was not the case the first time.

It's because of the first commit which removes an unnecessary file in the tests/ directory.

popescu-v added 2 commits May 29, 2026 14:34
- 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
Update Copilot instructions accordingly.
@popescu-v popescu-v force-pushed the 577-add-comprehensive-instructions-for-khiops-python-development branch from 1d73ab5 to f007510 Compare May 29, 2026 12:35

@tramora tramora left a comment

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.

Looks Good

@popescu-v popescu-v merged commit d6d4da1 into main May 29, 2026
16 checks passed
@popescu-v popescu-v deleted the 577-add-comprehensive-instructions-for-khiops-python-development branch May 29, 2026 13:01
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