Skip to content

readthedocs-fr/bin-client-vscode

Repository files navigation

Read The Bin

An extension to easily create bins with https://bin.readthedocs.fr.

Create a bin

Installation

Victim of its success, this extension is unfortunately no longer published on the Visual Studio Marketplace (to avoid overloading the bin server). You can still install it via https://github.com/readthedocs-fr/bin-client-vscode/releases or https://open-vsx.org/extension/readthedocs/rtdbin.

Contributing

After forking, do these commands:

git clone https://github.com/<your_username>/bin-client-vscode
cd bin-client-vscode

# we recommend you add this repo as an upstream remote (e.g. for updating your fork)
git remote add upstream https://github.com/readthedocs-fr/bin-client-vscode

yarn install

We use Conventional Commits for commits messages.

git checkout -b <branch_name>
# make somes changes

yarn lint # or lint-fix
yarn format
yarn build --noEmit # check typescript types

git commit -am "conventional commit"
git push origin <branch_name>

Testing

Open this project with Visual Studio Code, and click on Run Extension (or F5).