Skip to content

Add comment about local development #2772

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jan 14, 2023
Merged

Add comment about local development #2772

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fec111
Add comment about developing locally
weebl2000 Jun 24, 2021
713e2ce
Merge branch 'master' into add-comment-readme
newhoggy Jan 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,31 @@ Byron vote submission:
(--mainnet | --testnet-magic NATURAL)
--filepath UpdateProposalVoteFile

Development
===========

GHCID
-----

run *ghcid* with: ``ghcid -c "cabal repl exe:cardano-node --reorder-goals"``

Note: When developing locally, for any package you are working on, in **cabal.project** set, *ghc-options* to ``-Wwarn`` and set the ``development`` flag, e.g.::

package cardano-node
ghc-options: -Wwarn
flags: +development

Otherwise GHC might complain about unused packages.

Haskell Language Server
-----------------------

When using Haskell Langague Server with Visual Studio Code, you may find that
`HLINT annotations are ignored<https://github.com/haskell/haskell-language-server/issues/638>`.

To work around this, you may run the script `./scripts/reconfigure-hlint.sh` to generate a `.hlint.yaml`
file with HLINT ignore rules derived from the source code.

****
Native Tokens
****
Expand Down