nelsonic / nelsonic/github-scraper
Parse an Issue
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 456
- Forks
- 97
- PR merge metrics
- No merged PRs in 30d
Description
One of our original objectives with creating this module was to get all the issue in a given org and organise them in a single view. When GitHub changed the UI for issues last year our parser "broke" ... let's fix it now!
Tasks
- Go through each test in https://github.com/nelsonic/github-scraper/blob/master/test/issue.test.js and "unskip" one at a time making it pass by updating the selectors in https://github.com/nelsonic/github-scraper/blob/master/lib/issue.js
- title
- state (open/closed)
- author (person who opened the issue)
- created (date the issue was opened)
- comments - get the list of comments
- author - person who posted the comment
- created - date when the comment was posted
- body - the text of the comment
- labels - the labels that are currently applied to the issue
- assignees - the array of people assigned to work on the issue
- participants - array of people who have participated (commented) in the issue
Once we have this basic info we can work on the metadata contained in the page #43
Related to #24 (scrape an issue with a single comment)
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 with the skipped or incomplete cases in test/issue.test.js and the selectors in lib/issue.js. Work through the remaining comments requirements—author, created date, and body—and use the issue tests to verify that parsing the comment list is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 32/100