Skip to content
Snippets Groups Projects
Unverified Commit 18c7e84b authored by Hécate Moonlight's avatar Hécate Moonlight Committed by GitHub
Browse files

Update CONTRIBUTING.md to be clearer about the location of the QA notes (#9036)


* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

---------

Co-authored-by: default avatarmergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
parent e1a10bd8
No related branches found
No related tags found
No related merge requests found
Checking pipeline status
......@@ -125,11 +125,13 @@ are tested before being released. This allows us to catch UX regressions and put
a human perspective into testing.
Contributions that touch `cabal-install` are expected to include notes for the QA team.
They are a description of an expected result upon calling `cabal-install` with certain parameters.
They are a description of an expected result upon calling `cabal-install` with certain parameters,
and should be written in the body of the ticket or PR under their own heading, like this:
For instance:
> ## QA Notes
> \#\# QA Notes
>
> Calling `cabal haddock-project` should produce documentation for the whole cabal project with the following defaults enabled:
> * Documentation lives in ./haddocks
> * The file `./haddocks/index.html` should exist
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment