Skip to content

Commit

Permalink
contributing: Update dependency adding to the latest method
Browse files Browse the repository at this point in the history
  • Loading branch information
punchagan committed Feb 2, 2024
1 parent b86675d commit 23de8f3
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
You can add new benchmarks as follows:

- **Add dependencies to packages:** If there are any package dependencies your
benchmark has that are not already included in Sandmark, add its opam file to
`dependencies/packages/<package-name>/<package-version>/opam`. If the package
depends on other packages, repeat this step for all of those packages. Add
the package to `PACKAGES` variable in the Makefile.
benchmark has that are not already included in Sandmark, you can add it as a
dependency to `dependencies/template/dev-*.opam`. If you need to apply any
patches to the dependency, add its opam file to
`dependencies/packages/<package-name>/<package-version>/opam`, and the patch
to the `dependencies/packages/<package-name>/<package-version>/files/`
directory.

- **Add benchmark files:** Find a relevant folder in `benchmarks/` and add your
code to it. Feel free to create a new folder if you don't find any existing
Expand Down

0 comments on commit 23de8f3

Please sign in to comment.