Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example crates in data/test-packages #7

Open
cdstanford opened this issue Dec 18, 2022 · 1 comment
Open

Add example crates in data/test-packages #7

cdstanford opened this issue Dec 18, 2022 · 1 comment
Labels
good first issue Good for newcomers

Comments

@cdstanford
Copy link
Collaborator

cdstanford commented Dec 18, 2022

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.
@cdstanford
Copy link
Collaborator Author

After completing this, check out #8 for a follow-up issue to write a policy for your example crate.

@DavidThien DavidThien self-assigned this Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants