haskell / haskell/security-advisories

better documentation of Git-sourced fields when parsing

Open
#176 12 comments 0 reactions 0 assignees View on GitHub
Dominant language
Haskell
Stars
64
Forks
27
Avg merge
3h 39m
Merged PRs (30d)
1

Description

The fact we use the Git history to deduce the *published* and *modified* date fields is
non-obvious and can confuse users, because parsing our advisory content will fail if
they are divorced from the Git repo. We should improve the documentation about this.

*original summary retained below*

-----

## Summary
- remove an advisory
- toml parsing fails
## Expected behavior
- toml parsing works on some bag of advisories, there shouldn't have to be any constraints on them
## Cause of the bug

Contributor guide

Open the contributing guide

Research direction

Start by searching the repository documentation for the parsing behavior and references to the published and modified fields. Update the relevant documentation to explain that these dates are derived from Git history and describe the repository constraint that affects parsing; consider the work done when users can understand why detached advisory content may fail.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.