Skip to content

Conversation

tjugdev
Copy link
Contributor

@tjugdev tjugdev commented Oct 2, 2025

Overview

  • Update instructions for running unit tests
  • Add make clean which is referenced in the new steps
  • Fix the path referenced in ghc-options to not include a version. At least on my machine, there's a path with no version which is symlinked to the latest version.

Acceptance criteria

If this PR is successful, what impact does it have on the user experience?

Example: When users do X, Y should now happen.

Testing plan

How did you validate that this PR works? What literal steps did you take when manually checking that your code works?

Example:

  1. Set up test case X.
  2. Run command Y. Make sure Z happens.

This section should list concrete steps that a reviewer can sanity check and repeat on their own machine (and provide any needed test cases).

Risks

Highlight any areas that you're unsure of, want feedback on, or want reviewers to pay particular attention to.

Example: I'm not sure I did X correctly, can reviewers please double-check that for me?

Metrics

Is this change something that can or should be tracked? If so, can we do it today? And how? If its easy, do it

References

Add links to any referenced GitHub issues, Zendesk tickets, Jira tickets, Slack threads, etc.

Example:

Checklist

  • I added tests for this PR's change (or explained in the PR description why tests don't make sense).
  • If this PR introduced a user-visible change, I added documentation into docs/.
  • If this PR added docs, I added links as appropriate to the user manual's ToC in docs/README.ms and gave consideration to how discoverable or not my documentation is.
  • If this change is externally visible, I updated Changelog.md. If this PR did not mark a release, I added my changes into an ## Unreleased section at the top.
  • If I made changes to .fossa.yml or fossa-deps.{json.yml}, I updated docs/references/files/*.schema.json AND I have updated example files used by fossa init command. You may also need to update these if you have added/removed new dependency type (e.g. pip) or analysis target type (e.g. poetry).
  • If I made changes to a subcommand's options, I updated docs/references/subcommands/<subcommand>.md.

@tjugdev tjugdev requested a review from a team as a code owner October 2, 2025 16:32
@tjugdev tjugdev requested a review from nficca October 2, 2025 16:32
Copy link
Contributor

@nficca nficca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 👍

Comment on lines +70 to +71
- Create a GitHub Personal Access Token with repo access to FOSSA repos. Store the token in the environment variable `GITHUB_TOKEN`.
- Download vendor dependencies by running `./vendor_download.sh`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit; optional] These two are already covered in the "Building" section. Since that's the section right above this one it seems redundant to include it again.

@tjugdev tjugdev enabled auto-merge (squash) October 2, 2025 19:17
@tjugdev tjugdev merged commit ea08282 into master Oct 2, 2025
19 of 20 checks passed
@tjugdev tjugdev deleted the doc-updates branch October 2, 2025 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants