openscad / openscad/openscad.github.com
Requirements for inclusion in libraries list
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 34
- Forks
- 59
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
I wrote this a while ago in #185. There was some agreement that it was a good start on criterion, so it seems like it should be documented somewhere. I'm not sure where, other than that libraries.html itself should have a reference in HTML comments.
- Author requests addition.
- Open-ish license. (No advertising for commercial products.)
- Is in some real sense a library. Not an individual project or a random collection of work that you might be able to cherry-pick something interesting from.
- Is documented (not just comments).
Comments on how this should be documented?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read issue #185 and inspect libraries.html to understand how the libraries list is organized and where HTML comments are appropriate. Document the four proposed inclusion criteria and add a reference in libraries.html; done means the criteria are discoverable there and the page remains valid HTML.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100