llnl / llnl/scraper

Add documentation on how to extend scraper

Open
#36 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
59
Forks
28
PR merge metrics
No merged PRs in 30d

Description

Right now, the tool is fairly straightforward to extend if one goes through the source code, but there's currently no documentation on how to do it. Developers looking to leverage scraper for their source control platforms that are not yet supported (e.g., Subversion) would benefit from some kind of reference in order to figure out the integration points.

I'm curious what approach might work best:

1) Add a lightweight plugin system, where contributors can write their own Python packages, install them via pip, and add their config to config.json. Scraper simply invokes each plugin listed in the config and integrates the returned metadata into the final code.json file.

or

2) Don't modify scraper, just add comprehensive documentation on how contributors can add a new module. Contributors can then open a PR to merge the new feature.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the source code and tracing how config.json is read and how metadata reaches code.json. Identify the integration points for adding a source-control module, then document the contributor workflow and required interfaces. Done means contributors can understand how to support a platform such as Subversion, with the plugin-system versus module approach resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.