-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #397 from input-output-hk/smelc/contributing-link-…
…to-cardano-cli CONTRIBUTING: link to cardano-cli file
- Loading branch information
Showing
1 changed file
with
1 addition
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,3 @@ | ||
# Contributing to the `cardano-api` project | ||
|
||
The `cardano-api` development is primarily with Haskell tools. | ||
|
||
These can be provisioned with: | ||
|
||
```bash | ||
nix develop github:input-output-hk/devx#ghc8107-minimal-iog | ||
``` | ||
|
||
## Roles and Responsibilities | ||
We maintain a [CODEOWNERS file](CODEOWNERS) which provides information who | ||
should review a contributing PR. Note that you might need to get approvals | ||
from all code owners (even though GitHub doesn't give a way to enforce it). | ||
|
||
## Updating dependencies | ||
|
||
### From Hackage | ||
Updating package dependencies from Hackage should work like normal in a Haskell project. | ||
The most important thing to note is that we pin the `index-state` of the Hackage package index in `cabal.project`. | ||
This means that cabal will always see Hackage “as if” it was that time, ensuring reproducibility. | ||
But it also means that if you need a package version that was released *after* that time, you need to bump the `index-state` (and to run `cabal update` locally). | ||
|
||
Because of how we use Nix to manage our Haskell build, whenever you do this you will also need to pull in the Nix equivalent of the newer `index-state`. | ||
You can do this by running `nix flake lock --update-input haskellNix/hackage`. | ||
|
||
### from the Cardano package repository | ||
Many Cardano packages are not on Hackage and are instead in the [Cardano Haskell Package (CHaP) repository][CHaP]. | ||
|
||
Getting new packages from there works much like getting them from Hackage. | ||
|
||
The differences are that it has an independent `index-state`, and that there is a different Nix command you need to run afterwards: `nix flake lock --update-input CHaP`. | ||
|
||
## Using unreleased versions of dependencies | ||
Sometimes we need to use an unreleased version of one of our dependencies, either to fix an issue in a package that is not under our control, or to experiment with a pre-release version of one of our own packages. | ||
You can use a `source-repository-package` stanza to pull in the unreleased version. | ||
|
||
Try only to do this for a short time, as it does not play very well with tooling, and will interfere with the ability to release the `cardano-api` itself. | ||
|
||
For packages that we do not control, we can end up in a situation where we have a fork that looks like it will be long-lived or permanent (e.g. the maintainer is unresponsive, or the change has been merged but not released). | ||
In that case, release a patched version to the [CHaP repository][CHaP], which allows us to remove the `source-repository-package` stanza. | ||
|
||
## Releasing a version of the `cardano-api` | ||
|
||
### to the Cardano Haskell Package repository | ||
|
||
When releasing a new version of `cardano-api`, it and the other packages in this repository should be released to the [CHaP repository][CHaP]. | ||
|
||
See the [RELEASING.md] for instructions. | ||
|
||
Please note that libraries need bounds on the version of their dependencies to avoid bitrot and be effectively reusable. | ||
|
||
[CHaP]: https://github.com/input-output-hk/cardano-haskell-packages | ||
Please see [cardano-cli's CONTRIBUTING.md](https://github.com/input-output-hk/cardano-cli/blob/main/CONTRIBUTING.md) file. |