Codify Standards - Githubissues

itdependsnetworks commented 1 year ago

P.D. - Plugin Developer

the ability to be inline with the current standards and best practices, without requiring a substantial time to be able to learning that system.

I know that plugin is as rock solid as it can be

I have an easy method of enforcement of the best practices
- In an ideal (but unrealistic) world I would have a "formatter" similar to black
- In a realistic world, I have the ability to quickly create tests that let me know which standards I have met or not

N/A

itdependsnetworks commented 1 year ago

As always, I will separate a potential solution from the definition of done. I think it makes sense to use a custom Pylint checker.

itdependsnetworks commented 1 year ago

Examples include:

Ensuring that navigation permissions are in place
Filters
- ensure using best practice base class
- Ensure that you are using the right "type", e.g. NameSlugSearchFilterSet vs ???
- I think you are not supposed to set fields when the attribute exists already?
- Ensure classes are using proper name
- Ensure there is a q filter
Forms
- Ensure csvform uses the csv_headers attribute on the model
- Ensure classes are using proper name, e.g. Form / FilterForm
- Ensure there is a q filter
Models
- Ensure classes are using proper name
- Ensure we don't override defaults on model fields
- Ensure to_csv and csv_headers are set
- Ensure extra features are set and/or don't override each other (i think there is something with status here? )
Ensure using views
Best Practices, anything in https://docs.nautobot.com/projects/core/en/stable/development/best-practices/

Other examples

bryanculver commented 11 months ago

Assigning myself to Move these over to pylint-nautobot

nautobot / pylint-nautobot