Conan-center-index: [question] Package naming

Created on 25 Sep 2019  路  4Comments  路  Source: conan-io/conan-center-index

Hi!

When submitting a new PR, adding a new package, some of them could contain multiple words and as separator we have some options: -, _

As users can deduce the package name when searching, probably anyone would prefer a pattern for cases where a separator is required, so we can deduce easily the correct package name.

However, Conan Center Index has both separators included:

  • expected-lite
  • libjpeg-turbo
  • ms-gsl
  • optional-lite
  • xz_utils

Famous packages like Boost modules use _.

We could create a new rule for new packages, where the hook is able to check the package name, also as CCI is just on the beginning, so I think we can rename some packages to follow the same pattern.

But first, we need to vote for a specific separator.

/cc @Croydon

help wanted question

Most helpful comment

I have added a new section in the FAQ and updated the existing one with the GSL example: https://github.com/conan-io/conan-center-index/wiki/FAQ

Thanks for the feedback!

All 4 comments

I'd try to stick to the original name as much as possible. For example libjpeg-turbo and expected-lite and optional-lite have the - in their names.

In the case of spaces in the name , I'd rather go for the _ as correctly done in xz_utils.

Finally, in the case for disambiguation, I'd use common sense as said in #21. Also if you look for ms-gsl on google, you get the right result in the first position. If you write ms_gsl you get nothing 馃槃

If we agree on this, I could add this to the FAQ question about naming and close the issue. Thanks!

Having a unified style would hurt the discoverability, indeed.

I have added a new section in the FAQ and updated the existing one with the GSL example: https://github.com/conan-io/conan-center-index/wiki/FAQ

Thanks for the feedback!

Was this page helpful?
0 / 5 - 0 ratings