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 issue templates for the entire org #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dcmiddle
Copy link

@dcmiddle dcmiddle commented Aug 8, 2024

Adding issue templates to the .github repo makes them available in all OPEA repositories. Templates improve the quality of bug reports and feature requests.

Adding issue templates to the .github repo makes them available in all
OPEA repositories. Templates improve the quality of bug reports and
feature requests.

Signed-off-by: Dan Middleton <[email protected]>
@dbkinder
Copy link
Contributor

dbkinder commented Aug 8, 2024

Thanks for contributing this Dan, and appreciate you did the Signed-off-by line :)
Are the reviewers OK with this global PR/Issues template? I wasn't sure if this would overwrite any specific repo's templates.

@dcmiddle
Copy link
Author

dcmiddle commented Aug 9, 2024

I believe each repo can override the org level templates by specifying their own.

@kding1 kding1 requested a review from chensuyue August 13, 2024 15:23
@dcmiddle
Copy link
Author

Hi, I received offline feedback to look at Langchain's feature request template. It appears to not be an issue template but a link to a discussion board. https://github.com/langchain-ai/langchain/discussions/categories/ideas

I don't have experience with the discussions feature so I can't provide guidance how best to use that mechanism.
My recommendation is to provide issue templates for bugs and feature requests. I imagine that if the number of feature requests grows too rapidly that would be a sign to switch to a discussion board.

cc: @arun-gupta @chickenrae

@arun-gupta
Copy link

@dcmiddle here is the template that I shared in email https://github.com/langchain-ai/langchain/issues/new/choose

@dcmiddle
Copy link
Author

Thanks for the clarification @arun-gupta. I believe that view is defined by the issue templates and a config.yml that adds links for things like discussions which aren't otherwise defined by issue templates. I think if we merge this PR as is then a menu will be produced.

See for example langchain defines 3 issue templates {bug, doc, and priv} here:
https://github.com/langchain-ai/langchain/tree/master/.github/ISSUE_TEMPLATE

As well as a config.yml to cover other topics via discussions:
https://github.com/langchain-ai/langchain/blob/master/.github/ISSUE_TEMPLATE/config.yml

@dcmiddle
Copy link
Author

Any other feedback?

@arun-gupta
Copy link

@kding1 any thoughts on this?

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.

3 participants