lincc-frameworks / lincc-frameworks/python-project-template
Nice to have: a page in the PPT docs with basics of OOP, modules, rel imports, etc
Open
Beginner friendly
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- Jinja
- Stars
- 85
- Forks
- 16
- Avg merge
- 6h 18m
- Merged PRs (30d)
- 1
Description
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.
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
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.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100