You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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.
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.
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 (notdocs
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.
The text was updated successfully, but these errors were encountered: