search

carapace-sh / carapace-bin

multi-shell multi-command argument completer
https://carapace.sh
MIT License
861 stars 47 forks source link

Add developer/contributing documentation #2417

Closed samuelallan72 closed 3 months ago

samuelallan72 commented 3 months ago

Request

As a new contributer to the project, it was difficult to figure out how to build and run the project. (I had to read through the github workflow files and translate that to local commands.) It would be nice to have a developer doc with information about how to build, run, and test the project, as well as any useful information to contributors (best practices, guidelines, etc.).

Proposed solution

No response

Anything else?

No response

rsteube commented 3 months ago

Build instructions are here: https://carapace-sh.github.io/carapace-bin/development/build.html

samuelallan72 commented 3 months ago

Ah I missed that, thanks for the link. :)