Update CONTRIBUTING.md #262
Conversation
- remove sourcegraph/sourcegraph dependency - prefer `asdf` to install deps - break into subsections
CONTRIBUTING.md
Outdated
| - https://plugins.jetbrains.com/plugin/14912-ktfmt | ||
| - [Install `asdf`](https://asdf-vm.com/guide/getting-started.html) | ||
| - Run `asdf install` in the root directory of this repository | ||
| - If not using `asdf`, you can install the programs in `.tool-versions` through other means, but ensure the versions match. |
There was a problem hiding this comment.
I'd rather not reference nodejs & pnpm (.tool-versions) so directly. They are the agent's requirements (not plugin's). Hence, asdf mention seems to be redundant here too.
The agent has its own .tool-versions. Having the same lib version declarations in these two files may lead to inconsistency. What if the agent specifies nodejs 20.4.0 but the plugin tells it's 18.18.2 (this is the actual case right now)?
There was a problem hiding this comment.
I think it makes sense to keep .tool-versions in sync with the agent .tool-versions. I have hit on issues where building the agent from source fails if I don't have the right dependencies where I run ./gradlew :runIde
There was a problem hiding this comment.
Why do we need both .tool-windows if jetbrains on itself does not need pnpm?
I hit the same issues when I tried first time to build everything, but at that time I haven't got asdf installed.
My understanding is that when grade will run pnpm in the cody dir, it should automatically read asdf settings from cody and use proper runtime automatically. Isn't that the case?
As for asdf installation and other dependencies needed for cody I thin we should simply link to the:
https://github.com/sourcegraph/cody/blob/main/doc/dev/index.md
This way we won't need to manually keep both docs in sync.
There was a problem hiding this comment.
Agree that we should ideally pick up the asdf settings from the Cody repo. I haven't gotten this working, but I haven't spent much time investigating it either because I've been able to work around it by having the right environment when running Gradle.
I'm fine either way we go.
BTW, I use rtx instead of asdf because it it's more intuitive and works more reliably for me. rtx is compatible with asdf .tool-version files.
asdfto install depsTest plan
Dev docs only