CONTRIBUTING.md

Contributing to Overleaf Workshop

The Overleaf Workshop extension is an open source project and we welcome contributions of all kinds from the community. There are many ways to contribute, from improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the extension itself.

In this document, we will mainly elaborate on how to make code contributions to the project.

Contribution Guidance

Warning

We will not accept any pull request that is not associated with an issue. If you have any question about the project, please create an issue or discuss it in the Discussions section.

To make a contribution to this project, please follow the steps below:

1. Create or find an Bug Report or Feature Request issue on GitHub.

   If you are creating a new issue, please make sure that it is not a duplicate of an existing issue.

2. Fork this repository and create a new branch from master branch.

   It is recommended to name the branch with the issue number, e.g., issue-123, or related keywords, e.g., fix-xxx, feat-xxx.

3. Make your changes and commit them to the new branch.

   Please make sure that your commit messages follow the Conventional Commits specification.

4. Create a pull request to the master branch of this repository.

   Please make sure that the pull request is associated with the issue you are working on. If you do not know how to do this, please refer to Linking a pull request to an issue.

5. Wait for the assigned reviewer to review your pull request.

   If there are any problems, please fix them and commit the changes to the same branch with rebase. If the reviewer approves your pull request, it will be merged into the master branch.

6. After the pull request is merged, the associated issue will be closed automatically.

Development Guidance

Prerequisites

• Node.js LTS (>= 20.10.0)
• Visual Studio Code (>= 1.80.0)

  Recommended extensions: ESLint, JavaScript and TypeScript Nightly, Vue Language Features (Volar), TypeScript Vue Plugin (Volar)

• Operating System with common Unix commands.

  If you are using Windows, please refer to Windows Subsystem for Linux, Cygwin or Git Bash. You can also use gow installed with scoop.

Build

# Clone the Repository and Change Directory
git clone https://github.com/iamhyc/Overleaf-Workshop.git
cd Overleaf-Workshop

# Install `vsce` globally
npm install -g vsce # may require `sudo` on Linux

# Install dependencies
npm install
cd views/chat-view && npm install && cd ../..

# Build the Extension
npm run compile

# [Optional] Package the Extension
vsce package

Testing

In VSCode, press F5 to start debugging. A new VSCode window will be opened with the extension loaded.

Documentation

• VSCode Extension API
• Overleaf Workshop Extension Documentation