extern/devicetype-library
1
0
Fork 0
mirror of https://github.com/netbox-community/devicetype-library.git synced 2024-11-24 09:23:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Daniel Sheppard 2022-09-15 21:08:41 -05:00 committed by GitHub
parent 8575bbeba6
commit e7e6c4bc64
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -18,9 +18,8 @@ When writing new definitions, there are some important guidelines to follow:
- Every unique model number requires a discrete definition file, even if the set of components is identical.
- Definition files must end in `.yaml`, or `.yml`
- Use proper, human-friendly names when creating manufacturer directories (e.g. `Alcatel-Lucent` versus `alcatel`).
- Include only components which are fixed to the chassis. Optional modular components should be omitted from the
definition. (Note that this does not exclude field-replaceable hardware that is expected to always be present, such
as power supplies.)
- Include only components which are fixed to the chassis. Module bays and associated module types should be included for
all modular components which can be modelled in NetBox (network modules, power supplies, etc).
- Name components exactly as they appear in the device's operating system (as opposed to the physical chassis label, if
different).
- Use the complete form of interface names where applicable. For example, use `TenGigabitEthernet1/2/3` instead of