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-specific guidelines and templates #2364

Open
1 of 4 tasks
thehans opened this issue Apr 1, 2018 · 3 comments
Open
1 of 4 tasks

Add Github-specific guidelines and templates #2364

thehans opened this issue Apr 1, 2018 · 3 comments

Comments

@thehans
Copy link
Member

thehans commented Apr 1, 2018

This is a suggestion to add some files to OpenSCAD repo for integrating guidelines and templates with Github.

There are a few files that Github looks for (in root, docs or .github folders), and when they exist it uses these to prompt users with templates or links to guidelines etc.

These are 4 that I am aware of:

I'm not sure that all of them are completely necessary, but I think at least an Issue template would be useful towards improving the quality of reported issues. Also in my opinion the .github folder would be the best path choice for these files.

Here is an example of a project which has these files in a .github folder:
https://github.com/MarlinFirmware/Marlin/tree/1.1.x/.github

We do have existing documentation in a few places, some of which might be useful to copy/paraphrase into potential new github-specific stuff. In the wiki manual, in our doc folder (not docs that github looks for), and in pinned posts on forums.
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/FAQ#How_do_I_report_bugs?
http://forum.openscad.org/Reporting-Bugs-not-just-general-queries-td21787.html


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

@t-paul
Copy link
Member

t-paul commented Apr 1, 2018

Yes, I eyed those a couple of times already. I'm not sure that helps a lot when just puting in the docs. Just look at the latest issues created on the Marlin repo. It does not seem to help. It might work together with some automatic enforcement like the bot Gina uses for Octoprint.

@thehans
Copy link
Member Author

thehans commented Nov 14, 2022

Mentioning a "CONTRIBUTING" file for better searchability.

@t-paul
Copy link
Member

t-paul commented Apr 17, 2023

Issue templates added via #4607.

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

No branches or pull requests

2 participants