Add a note to the git hook section that the Web UI dependencies/tooling needs to be set up for the hooks to work. #6015

Closed
opened 2025-12-29 19:35:43 +01:00 by adam · 2 comments
Owner

Originally created by @991jo on GitHub (Jan 28, 2022).

Change Type

Addition

Area

Administration/development

Proposed Changes

The git pre-commit hooks require the web UI dependencies (yarn, node, typescript) to be set up to work.
It is very frustrating to enable the hooks and have your commit hooks failing because of missing dependencies.
Since the pre-commit hooks are encouraged it would be nice to tell people that the additional tooling described in the Web UI section is also required to run those.

A short note like

Install yarn, node, typescript, run yarn and yarn bundle in netbox/project-static to make the UI tooling work
For more details take a look at the Web UI section.

reduces the amount of time a first time contributor needs to spend debugging the build environment.
Also keep in mind that many people that are just fixing a small bug might not be Frontend-Devs and are not very familiar with all the tooling and how it works. (I include myself in this group.)

Originally created by @991jo on GitHub (Jan 28, 2022). ### Change Type Addition ### Area Administration/development ### Proposed Changes The git pre-commit hooks require the web UI dependencies (yarn, node, typescript) to be set up to work. It is very frustrating to enable the hooks and have your commit hooks failing because of missing dependencies. Since the pre-commit hooks are encouraged it would be nice to tell people that the additional tooling described in the Web UI section is also required to run those. A short note like > Install yarn, node, typescript, run `yarn` and `yarn bundle` in `netbox/project-static` to make the UI tooling work > For more details take a look at the Web UI section. reduces the amount of time a first time contributor needs to spend debugging the build environment. Also keep in mind that many people that are just fixing a small bug might not be Frontend-Devs and are not very familiar with all the tooling and how it works. (I include myself in this group.)
adam added the status: acceptedtype: documentation labels 2025-12-29 19:35:43 +01:00
adam closed this issue 2025-12-29 19:35:43 +01:00
Author
Owner

@github-actions[bot] commented on GitHub (Mar 30, 2022):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Mar 30, 2022): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
Author
Owner

@jeremystretch commented on GitHub (Aug 26, 2022):

Looks like this was taken care of under #10139.

@jeremystretch commented on GitHub (Aug 26, 2022): Looks like this was taken care of under #10139.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#6015