Can we update the documentation to provide a full working example for 2020 onwards.
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 603
- Forks
- 142
- PR merge metrics
- No merged PRs in 30d
Description
As it stands there are a bunch of gotchas with this project. From certain versions of packages not working (we eventually learn it is related to the fact they aren't pulling from Pypi) to having a very tight coupling to pivy-importer (which is admitted to be more of a throwaway as linkedin use an internal package) I feel the documentation needs an overall.
Without clear working examples to get this repo working in a project I feel its use is hindered. Theres alot of tacit knowledge involved. From what I can see in the github issues, the two example projects are heavily suggested to people. But neither of them seem to have been updated in two years.
Is there any official plan for maintaining this project?
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
The issue names no specific files or tests; start by reviewing the current documentation and the two example projects referenced in the report. Check the documented package sources and pivy-importer coupling, then define a maintained, full working example for 2020 onwards and document the project's maintenance expectations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100