PLSysSec / PLSysSec/cargo-scan

Add example crates in `data/test-packages`

Open
#7 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Rust
Stars
47
Forks
7
PR merge metrics
No merged PRs in 30d

Description

This is an open issue that would be good for everyone involved to do at least once to start out!

To add an example crate:

  • make a directory in data/test-packages and run cargo init inside it
  • add whatever Rust source files you want and make sure it compiles
  • check the output of cargo run --bin scan -- data/packages/<your crate>. Report anything you think is weird/should be fixed

Finally, add the crate to automatically be updated on make test so that we can track the output. To do that:

  • add the crate name to data/crate-lists/test-crates.csv
  • run make test to check the output on your own machine.
  • push your code; the GitHub actions workflow should automatically include the results in the repo on the next run.

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

Create a crate under data/test-packages with cargo init, add Rust sources, and confirm it compiles. Run cargo run --bin scan -- data/packages/, then add the crate name to data/crate-lists/test-crates.csv and run make test to verify the tracked output.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
testing-qa
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.