refactor: change exposed methods and accepted types

mljs / tree-similarity

Tree similarity in Javascript

MIT License

8 stars 1 forks source link

refactor: change exposed methods and accepted types #12

Closed jobo322 closed 7 months ago

jobo322 commented 7 months ago

BREAKING CHANGE:

treeSimilarity now only accepts Tree objects
createTree expects an object {x: [],y: []}

targos commented 7 months ago

The message for the changelog is wrong (breaking change is not the rename of the method). You should remove the ! from the title and add a BREAKING CHANGE: section with the actual breaking changes.

jobo322 commented 7 months ago

@targos I have a question about the use of .d.ts to store the types. Is it needed to point to this file in the package.json or is it just enough with the importation in the jsdoc?

targos commented 7 months ago

You need to create a "types" key in the package.json that points to the file, and also include the file in the distribution (files array in package.json).

jobo322 commented 7 months ago

The message for the changelog is wrong (breaking change is not the rename of the method). You should remove the ! from the title and add a BREAKING CHANGE: section with the actual breaking changes.

It is correct now?

targos commented 7 months ago

No, please have a look at the message I reworded: https://github.com/mljs/tree-similarity/commit/3ec97d83018b40a55e6048153472fdf9314b1825

It is not a fix
We only talk about the breaking changes from the perspective of the end user

targos commented 7 months ago

I'm sorry, the format was actually wrong. Here is a new version that works: https://github.com/mljs/tree-similarity/commit/ec9318f470600cf028476ef7b37ed08c3560587d

We cannot have an empty line for BREAKING CHANGE: In general, I think the best way to solve this is to make more than one commit, so each commit has its description and BREAKING CHANGE: section.