Improve CONTRIBUTING.md by adding some guidance into the codebase for people who want to contribute to the code #5858
Conversation
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
… people who want to contribute to the code
rjbou
reviewed
Mar 1, 2024
|
|
||
| As long as you have the dependencies, compiling opam is as simple as: | ||
| ``` | ||
| ./configure |
There was a problem hiding this comment.
Suggested change
| ./configure | |
| ./configure --enable-developer-mode |
i don't know if it is still needed with the ability to have several caches now
| ### Layout | ||
|
|
||
| The source code of opam is located in `src`. In this directory you will find subdirectories. | ||
| Each subdirectories have different puposes: |
There was a problem hiding this comment.
We could link to https://opam.ocaml.org/doc/api/
|
|
||
| Each `*.test` files in `tests/reftests` start with either `N0REP0` (empty repository, note the zeros) or a valid hash coming from opam-repository that the test starts with. | ||
|
|
||
| After that every lines starting with `### ` will be parsed as either a command or a custom action as defined by `tests/reftests/run.ml`, everything else will be the output of the command or the input of the custom commands, with the exception of `# Return code <n> #` when the command returns a non-zero exit code. |
There was a problem hiding this comment.
Redirect to run.ml for more specific documentation on the syntax?
| make reftest-<name of the test> DUNE_ARGS="--auto-promote" | ||
| ``` | ||
| if you want to regenerate a test based on the new output of opam. | ||
|
|
There was a problem hiding this comment.
Should we also add how to add a new test file? It is maybe too specific for a generic contributing section.
|
|
||
| If you have opam installed already, you can call: | ||
| ``` | ||
| opam install --deps-only -t . |
There was a problem hiding this comment.
The -t is here for opam-devel ?
| ``` | ||
| if you want to regenerate a test based on the new output of opam. | ||
|
|
||
| ### Layout |
There was a problem hiding this comment.
Should we also add a section on the doc?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm unsure if there already was such documentation somewhere but in any case it could be a nice entry point for potential contributors
TODO:
shell/(install.sh, bootstrap, "other scripts")