QuantEcon / QuantEcon/QuantEcon.py
Update Developer Contribution Guide
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 2.4k
- Forks
- 2.3k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 3
Description
We should update our developer / contribution guidance once #601 is merged to be clear on how to manage visibility.
The main aim is to reduce all the duplicate entries that was happening with all the modules visible via introspection to improve user experience.
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 reviewing issue #601 and locating the current developer or contribution guidance. Clarify how visibility should be managed to prevent duplicate introspection entries, then update the guidance so it explains that process and its intended user-experience outcome.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100