PromtEngineer / PromtEngineer/localGPT
[V2] Adding more refence docs
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 22.2k
- Forks
- 2.5k
- PR merge metrics
- No merged PRs in 30d
Description
Great project.
I see big parts of the codebase are commented but some are not.
Would you be interested in some PRs documenting more of it?
I'm willing to help with that.
Contributor guide
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 surveying the codebase to identify which uncommented areas need reference documentation. Confirm the scope and documentation format with maintainers before proceeding; done means the agreed areas are documented and the resulting references are accurate and complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100