Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Extend readme

Open
#15 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by reading the README and reviewing the project structure to understand what a high-level schematic, usage example, and hacking notes should cover. Done means the README includes all three requested sections with accurate, useful guidance for users and contributors.

Written by the indexing model from the issue text.

Description

  • High level schematic
  • Usage example
  • Few words on hacking
Dominant language
C++
Stars
37
Forks
22
PR merge metrics
No merged PRs in 30d

Getting set up

We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from CadQuery/pywrap

All issues in CadQuery/pywrap

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.