oracle / oracle/macaron

Create template/library policies to improve usability

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

Nobody has claimed this yet.

policy engine
Dominant language
Python
Stars
210
Forks
36
Avg merge
1d 10h
Merged PRs (30d)
2

Description

  • We need to provide template policies that can be used to detect certain violations with minimal changes (e.g., only requiring to set the software component's PURL) and with no requirement to understand Datalog.
  • These policies can also be created as Datalog libraries. Users should be be able to import them easily and build upon them.
  • The Datalog relations/library APIs need to be documented on the website.

Contributor guide

Open the contributing guide

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 reviewing the existing policy system, Datalog relations and library APIs, then inspect the website documentation structure. Define the scope for reusable template policies, importable libraries, and API documentation. Done means users can apply templates with minimal configuration, build on imported libraries, and find the relevant API guidance on the website.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, security, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.