search

Docmaps-Project / docmaps

Extensible protocol for document history metadata exchange, to enable trustworthy, rapid, open science, by and for preprint science communities.
MIT License
15 stars 1 forks source link

[Repository structure]: Package naming #55

Open ships opened 1 year ago

ships commented 1 year ago

Bug Report

Currently, the docmaps-sdk package is released from the subdirectory packages/ts-sdk, and the @docmaps/etl package is released from packages/ts-etl. It is awkward that there are 3 patterns for naming present in this setup. We should normalize at least symmetry between the packages in this repository, and possibly the naming of the directories should match to the NPM package name as well.

Expected behavior

Open to discussion! cc @gabestein . It should be easy to infer the naming based on observing the convention.

Actual behavior

See above

Additional information

The tool multi-semantic-release may introduce some constraints here, based on how the feat(pkg): syntax is parsed, but so far it is equivalent to say feat(ts-sdk): and feat(docmaps-sdk):, see releases

ships commented 1 year ago

@3mcd , opinions?

3mcd commented 1 year ago

Here's a monorepo I hack on occasionally that has a somewhat consistent naming structure: https://github.com/3mcd/javelin/tree/next

The package directories are named like packages/{libname}-{pkgname} and the packages are published to npm named @{libname}/{pkgname}. I'm not sure how important it is to have the ts- prefix, IMO we could drop it.