deblan-mirror/thelounge
deblan-mirror/thelounge
1
0
Fork 0
mirror of https://github.com/thelounge/thelounge.git synced 2024-06-03 14:22:19 +02:00
Code Issues Projects Releases Wiki Activity

update docs and remove contributing reference

Browse source
This commit is contained in:
kinghat 2023-03-28 14:01:27 -05:00
parent 413bb4f654
commit d2caf3e412
2 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.github/CONTRIBUTING.md vendored
View file

@ -35,4 +35,3 @@ your contributions.
on save ([see VS Code one here](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)).
- We have a git hook to automatically run prettier before commit, in case you don't install the plugin.
- If for any reason, prettier does not work for you, you can run `yarn format:prettier` and that should format everything.
- When using VS Code, configuration files have been provided to take advantage of their [container development infrastructure](https://code.visualstudio.com/docs/remote/containers).

14
README.md
View file

@ -91,4 +91,16 @@ Before submitting any change, make sure to:
- The built files will be output to `dist/` by tsc
- `yarn dev` can be used to start The Lounge with hot module reloading
If you would like to work on The Lounge in a VS Code devcontainer, specific configuration files have been provided. If not prompted, use the `Rebuild and Reopen in Container` command to get going. More info in [Contributing](.github/CONTRIBUTING.md).
### Dev Container
If you already have VS Code and Docker installed, you can click the badge below to get started. Clicking the badge will cause vscode to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/thelounge/thelounge)
Other options to getting started with this repository in a dev container are to have the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension installed and:
- Simply open vscode and trigger the command palette(`Ctrl + Shift + P`) and type "clone" for the options `Clone Repository in (Named) Container Volume` or `Clone GitHub Pull Request in Container Volume`.
- Clone the repository to your machine, and after opening it vscode, click the "Reopen in Container" dialog. If the dialog doesn't trigger you can use the command palette and type "Reopen in Container".
Further Dev Container resources can be found [here](https://code.visualstudio.com/docs/devcontainers/containers).