Add a CONTRIBUTING.md document
#1752
Merged
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
xvw
reviewed
Apr 19, 2024
Unclear usefulness / rightfulness, requires more discussions
3Rafal
reviewed
Apr 24, 2024
3Rafal
reviewed
Apr 24, 2024
3Rafal
reviewed
Apr 24, 2024
pitag-ha
approved these changes
May 9, 2024
Comment on lines
+87
to
+89
| #### `/src/dot-protocol` | ||
| The configuration protocol that configuration servers such as | ||
| `dot-merlin-reader` or `dune ocaml-merlin` should implement. |
There was a problem hiding this comment.
Is it worth mentioning Dune RPC here as well as an alternative to dot-merlin-reader and dune ocaml-merlin (it's a genuine question)? We don't have documentation on how Dune communicates with the Merlin server via RPC that we could point to, right?
There was a problem hiding this comment.
It is not yet an existing alternative, I don't think we need to mention it here right now.
Co-authored-by: Rafal Gwozdzinski <[email protected]> Co-authored-by: Sonja Heinze <[email protected]>
Co-authored-by: Sonja Heinze <[email protected]>
Co-authored-by: Sonja Heinze <[email protected]>
xvw
approved these changes
May 16, 2024
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.
This is a first draft of the CONTRIBUTING document in an effort to make Merlin less intimidating to potential contributors :-)
Any
feedbackcontribution is welcome :-)cc @xvw @pitag-ha