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 .github/ISSUE_TEMPLATE config to encourage forum discussions. #2

Merged
merged 1 commit into from
Feb 2, 2023

Conversation

mstenta
Copy link
Member

@mstenta mstenta commented Feb 2, 2023

This is copied from the farmOS/farmOS repo. The goal is to direct people to the forum and chat for more general discussions, feature requests, etc, and reserve the GitHub repo for bug reports and internal task management.

This documentation explicitly mentions the ISSUE_TEMPLATE directory as being possible: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#creating-a-repository-for-default-files

I will open a companion PR in the farmOS/farmOS repo to remove it from there.

This is copied from the farmOS/farmOS repo. The goal is to direct people to the forum and chat for more general discussions, feature requests, etc, and reserve the GitHub repo for bug reports and internal task management.
Copy link

@symbioquine symbioquine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

@mstenta mstenta merged commit 960ef34 into main Feb 2, 2023
@mstenta mstenta deleted the issue-template branch February 2, 2023 17:09
@mstenta
Copy link
Member Author

mstenta commented Feb 2, 2023

Hmm I merged this but it doesn't seem to be working on other repos... :-(

Investigating more...

@paul121
Copy link
Member

paul121 commented Feb 2, 2023

I think this needs to be moved into the .github directory of this repo. Currently it is only at the root of the farmOS/.github repo.

@mstenta
Copy link
Member Author

mstenta commented Feb 2, 2023

Hmm I didn't think that was necessary. I think GitHub treats this as a special repo and expects everything that would normally be in a .github subdirectory to be in the root directory. I could be wrong though. The doc link above suggests this is correct I think.

@mstenta
Copy link
Member Author

mstenta commented Feb 2, 2023

Oh maybe you're right @paul121 ... rereading and it is worded confusingly, but lets give it a try!

@mstenta
Copy link
Member Author

mstenta commented Feb 2, 2023

That did it! 🙌

@paul121
Copy link
Member

paul121 commented Feb 2, 2023

Awesome! Sorry I could have linked to where I saw this. Seems more clear in step 7: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#creating-a-repository-for-default-files

In the repository, create one of the supported community health files. Issue templates and their configuration file must be in a folder called .github/ISSUE_TEMPLATE. All other supported files may be in the root of the repository, the .github folder, or the docs folder.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants