feat: add AI guidance files copilot.md and agent.md (#518)#525
Open
pankajbaid567 wants to merge 3 commits into
Open
feat: add AI guidance files copilot.md and agent.md (#518)#525pankajbaid567 wants to merge 3 commits into
pankajbaid567 wants to merge 3 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Title: Feat: Add AI guidance files
agent.mdandcopilot.md(#518)Description
This PR resolves issue #518 by adding AI guidance files to improve the developer and contributor experience when using LLM tools (e.g., GitHub Copilot, Cursor, ChatGPT) alongside pyGAM.
Changes Made
copilot.md: Specialized instructions designed for GitHub Copilot regarding pyGAM model terms, tuning mechanisms (gam.gridsearch), internal state persistence, and Python layout/style configurations.agent.md: Broader developer instructions containing tips and tricks for guiding conversational AI context windows, covering things like sharingsummary(), formatting withruffandblack, NumPy doctrine for documentation, and API style caveats when compared to sklearn's pipeline system.These files do not alter any core code or test structures and exist purely for development ecosystem improvement via AI.
Closes #518