Skip to content

Latest commit

 

History

History
77 lines (48 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

77 lines (48 loc) · 1.85 KB

Contributing to Unotes

Thank you for taking time to make Unotes even better!

Code of Conduct

Let's all get along and be nice. See the Unotes Code of Conduct.

What you need to know

Unotes is a Visual Studio Code extension written in JavaScript. Unotes consists of 2 main projects:

  • The Unotes Editor
  • The Unotes Extension

The Unotes Editor

This project wraps tui-editor in a React project. It needs to be built before the Unotes Extension Project. The code lives in the editor/src directory.

Installing

In the editordirectory run...

npm install

Building

In the root folder (not editor) run...

npm run build-editor

Note: Only npm <= v16.0 supported

The Unotes Extension Project

This is the root folder project. The extension code is in the ext-src folder. The extension provides the unotes tree view (UNotesProvider), several commands and settings, and a WebView (UNotesPanel).

Installing

In the root folder run...

npm install -g vsce
npm install

Building

First you must install and build the Unotes Editor (see above) and then run...

# to build in debug mode
npm run build
# you can now run it in VS Code by hitting F5

# to build in release mode
npm run pack

Building All

For convenience during development there is a build-all script that runs build-editor + build

npm run build-all

Pull Requests

  • Start by opening an issue or requesting assignment to an existing issue
  • Although there is currently no coding style enforced, please try to make the coding style to be consistent with existing files
  • Clearly describe the changes made in the pull request
  • Add notes on how to test and also on all testing that was performed