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

Nice to have: a page in the PPT docs with basics of OOP, modules, rel imports, etc

Open Beginner friendly
#589 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start by reviewing the existing PPT documentation structure and the pages aimed at scientific software users. Add a page covering Python-specific OOP syntax, modules, and relative imports, with enough basics to help readers familiar with OOP elsewhere; done means the page is integrated into the docs and covers the requested topics.

Written by the indexing model from the issue text.

Description

documentation good first issue

Inspired by incubee. I think this would be nice for other scientists too, or even anyone used to OOP but not 100% familiar with Python-specific syntax.

Dominant language
Jinja
Stars
85
Forks
16
Avg merge
6h 18m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

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 lincc-frameworks/python-project-template

All issues in lincc-frameworks/python-project-template

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.