Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename Releases.md to CHANGELOG.md #342

Closed
bxantus opened this issue Feb 22, 2021 · 2 comments
Closed

Rename Releases.md to CHANGELOG.md #342

bxantus opened this issue Feb 22, 2021 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@bxantus
Copy link
Contributor

bxantus commented Feb 22, 2021

Is your feature request related to a problem? Please describe.

It would be beneficial for this project to use a changelog.
When new updates arrive, users can check what's new, what has changed, what steps are necessary to ensure the correct working of the extension.

Describe the solution you'd like

Create a CHANGELOG.md file next to README.md and update it at least when new releases are created.
vscode will automatically show the changes next to extension's documentation.

You can use Keep a Changelog for format.
Here's the changelog for one of my own extensions: https://github.com/bxantus/mdoc/blob/master/CHANGELOG.md
@kitsonk kitsonk added the enhancement New feature or request label Feb 22, 2021
@lucacasonato
Copy link
Member

We have a Releases.md file: https://github.com/denoland/vscode_deno/blob/main/Releases.md

@kitsonk kitsonk reopened this Feb 22, 2021
@kitsonk
Copy link
Contributor

kitsonk commented Feb 22, 2021

@lucacasonato but if we moved it do CHANGELOG.md it would appear as part of the extension documentation, which makes it worth considering in my opinion.

Extension__Code_Spell_Checker_—_deno

@lucacasonato lucacasonato changed the title Consider using CHANGELOG.md Rename Releases.md to CHANGELOG.md Feb 22, 2021
@lucacasonato lucacasonato added the good first issue Good for newcomers label Feb 22, 2021
LumaKernel added a commit to LumaKernel/coc-denoland that referenced this issue Aug 7, 2021
@LumaKernel @kitsonk
@lucacasonato @Kirlovon @Liamolucko @ry @jsejcksn @CGQAQ @dsherret @hectormenendez @fannheyward @satyarohith @yaegassy @cvng
feat: merge v3.7.0 (#8)
fd7f096 
* feat: code lens for references (denoland#308)

* feat: disable most of builtin language service when deno enabled (denoland#307)

* 0.0.8

* feat: add applyCodeActionCommand command (denoland#312)

* fix: remove deno/applyCodeActionCommand (denoland#315)

* New high-res logo (denoland#274)

* feat: add implementations code lens configuration option (denoland#319)

* feat: add initialize workspace command (denoland#316)

* feat: support deno cache quick fix (denoland#322)

* chore: add screenshot to README (denoland#323)

* 0.0.9

* 0.0.10

* fix: typo in init command (denoland#327)

* feat: add a welcome screen for extension (denoland#329)

* feat: use preview instead of display for status (denoland#330)

* chore: README improvements (denoland#331)

* Release 3.0.0, canary is now main (denoland#332)

* 3.0.1

* Fix typo (denoland#337)

Grammar + context

* chore: activate extension on command (denoland#336)

* docs: recommend import_map.json instead of import-map.json (denoland#340)

Resolves denoland#338

* chore: move Releases.md to CHANGELOG.md for better marketplace integration (denoland#344)

Closes denoland#342

* feat: add deno.path setting (denoland#350)

* 3.1.0

* feat: read-add debug support (denoland#351)

Co-authored-by: CGQAQ <m.jason.liu@outlook.com>

* feat: add settings to affect completions (denoland#368)

* fix: manual `deno` command resolution on windows. (denoland#367)

Fixes denoland#361

* 3.2.0

* feat: support for relative path resolution (using workspaces) in deno.path (denoland#381)

Co-authored-by: Kitson Kelly <me@kitsonkelly.com>

* feat: add version notification message (denoland#383)

* feat: add restart language server command (denoland#385)

Resolves denoland#372

* feat: add support for import registry completions (denoland#380)

* 3.3.0

* typo in ImportCompletions.md (denoland#390)

* fix: activate on reloadImportRegistries command (denoland#407)

Fixes: denoland#394

* feat: handle per resource configuration (denoland#411)

Requires Deno with denoland/deno#10488.

Ref: denoland#348 
Resolves: denoland#314
Resolves: denoland#297

* feat: add internalDebug config flag (denoland#406)

Also integrate upstream formatting changes in deno fmt.

Ref: denoland/deno#10368

* 3.4.0

* feat: recognise json(c) & markdown files (denoland#404)

* 3.5.0

* docs: fix broken link in README (denoland#426)

* feat: support registry auto discovery (denoland#427)

* fix: bump semver of extension (denoland#429)

* 3.5.1

* feat: add support for tasks and test code lens (denoland#436)

* 3.6.0

* fix: update packaging and pin vsce version (denoland#440)

Fixes denoland#439

* 3.6.1

* feat: add support for import map in test code lens (denoland#446)

* fix: activate extension on markdown / json / jsonc (denoland#447)

* fix: setting then clearing "deno.path" config should not use empty string for path (denoland#452)

* fix: better handling when language server fails to start (denoland#454)

* 3.7.0

* fix: remove trailing slash in example (denoland#471)

* chore: remove test header from bug report issue template (denoland#479)

* feat: add ability to set cache directory in settings (denoland#477)

Closes denoland#287

* fix: properly handle plugin configuration at startup (denoland#474)

Fixes denoland#473

Co-authored-by: Kitson Kelly <me@kitsonkelly.com>
Co-authored-by: Luca Casonato <lucacasonato@yahoo.com>
Co-authored-by: Kirill Reunov <Kirlovon@outlook.com>
Co-authored-by: Liam Murphy <43807659+Liamolucko@users.noreply.github.com>
Co-authored-by: Ryan Dahl <ry@tinyclouds.org>
Co-authored-by: Jesse Jackson <jsejcksn@users.noreply.github.com>
Co-authored-by: CGQAQ <m.jason.liu@outlook.com>
Co-authored-by: David Sherret <dsherret@users.noreply.github.com>
Co-authored-by: Hector Menendez <hector@gik.mx>
Co-authored-by: Heyward Fann <fannheyward@users.noreply.github.com>
Co-authored-by: Satya Rohith <me@satyarohith.com>
Co-authored-by: yaegassy <yaegassy@users.noreply.github.com>
Co-authored-by: Cedric Vangout <mail@cvng.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kitsonk @bxantus @lucacasonato