search

arduino-libraries / Arduino_PortentaBreakout

GNU Lesser General Public License v2.1
10 stars 5 forks source link

Rename repository "Arduino_PortentaBreakoutLibrary" #2

Closed per1234 closed 3 years ago

per1234 commented 3 years ago

The names of all new official libraries must start with "Arduino_". This creates a "namespace" to avoid collisions with names already claimed by 3rd party libraries and differentiates the official offerings from unvetted 3rd party libraries.

It's best practices for the following three things to be the same:

The library installation folder name is determined by the name value when installed via Library Manager. The library installation folder name is determined by the repository name when installed via git clone or a .zip file download. The reason it's important for the primary header file name to match the installation folder is because File/folder name matching is one factor used to determine priority during dependency resolution.

https://github.com/bcmi-labs/PortentaBreakoutLibrary/pull/1 handles the renames of the latter two.

pennam commented 3 years ago

Just a reminder to all subscribers. Now that i have admin power :D tomorrow morning i will rename the repository.