Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for project instruction file #46

Merged
merged 1 commit into from
Sep 7, 2024

Conversation

yamadashy
Copy link
Owner

@yamadashy yamadashy commented Aug 11, 2024

This PR is adding support for project instruction file.

related: #40

Changes

  • Add instructionFilePath option to configuration
    • Update output generators to include project instruction in the output
  • Rename "user-provided header" to "project summary" for clarity

README
https://github.com/yamadashy/repopack/tree/feature/custom-instruction?tab=readme-ov-file#using-instructionfilepath-option

Purpose

This PR adds support for a separate project instruction file, allowing users to provide more detailed context and guidelines for AI analysis.

@yamadashy yamadashy force-pushed the feature/custom-instruction branch from 99d9f1c to 35bd34d Compare August 11, 2024 15:42
@yamadashy yamadashy force-pushed the feature/custom-instruction branch 5 times, most recently from 185b990 to 153a8cc Compare August 12, 2024 15:52
@yamadashy yamadashy force-pushed the feature/custom-instruction branch from 153a8cc to 5475f51 Compare September 5, 2024 16:03
@yamadashy
Copy link
Owner Author

I've been testing various approaches, including explicit instructions like:

## Important Rules and Conventions
1. Add as many comments as possible

However, getting consistent adherence is tricky. I'm still exploring better methods to improve this.

@yamadashy yamadashy force-pushed the feature/custom-instruction branch 4 times, most recently from 306a235 to 7315481 Compare September 7, 2024 14:08
@yamadashy
Copy link
Owner Author

I've decided to experimentally introduce this Custom Instruction feature.
The reason for this is that we've already tested it with several feature implementation proposals, and it seems to be working well in enhancing AI's understanding and suggestions for the project.

@yamadashy yamadashy force-pushed the feature/custom-instruction branch from 7315481 to 68b4c86 Compare September 7, 2024 14:34
@yamadashy yamadashy merged commit f001289 into main Sep 7, 2024
22 checks passed
@yamadashy yamadashy deleted the feature/custom-instruction branch September 7, 2024 14:41
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.

1 participant