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

[Feature Request] Reference existing files in extra_instructions #921

Open
yanivkrol opened this issue May 26, 2024 · 3 comments
Open

[Feature Request] Reference existing files in extra_instructions #921

yanivkrol opened this issue May 26, 2024 · 3 comments

Comments

@yanivkrol
Copy link

Hi,

I have a CONTRIBUTING.md file with guidelines for making a PR and writing code, and I would like to reference this file in the extra_instructions so the pr agent will make sure the guidelines are followed. I'm pretty sure it's not possible at the moment, at least not that I have found anything

@mrT23
Copy link
Collaborator

mrT23 commented May 26, 2024

That's an interesting feature. I don't think its related necessarily to extra instructions, but maybe to add an additional flag:

'make sure the PR follows CONTRIBUTING.md'

Or something like that.

My main concern is that sometimes CONTRIBUTING.md is very big, and it can take too many prompt tokens, and decrease the overall quality.

But we will think about it. It can be a valid option.

@yanivkrol
Copy link
Author

@mrT23 The user should choose if it is worth the tokens. I think the best thing a pr agent should be useful for is enforcing coding standards.

@mrT23
Copy link
Collaborator

mrT23 commented May 26, 2024

Most users dont understand what token means, how many tokens there are in CONTRIBUTING.md, how they compare to the actual PR content, and what it is the negative impact of too many tokens

It won't be the default option for sure. But an option that works poorly most of the time is still a bad option.
protections are needed. for example, if the CONTRIBUTING.md is too big, we should ignore it, and give a warning. that's how you build a sustainable feature.

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

No branches or pull requests

2 participants