starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Add a CONTRIBUTORS file #4601

New Issue
Closed
opened 2025-12-29 18:38:08 +01:00 by adam · 7 comments
adam commented 2025-12-29 18:38:08 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Feb 25, 2021).

Change Type

[x] Addition
[ ] Correction
[ ] Deprecation
[ ] Cleanup (formatting, typos, etc.)

Area

[ ] Installation instructions
[ ] Configuration parameters
[ ] Functionality/features
[ ] REST API
[ ] Administration/development
[x] Other

Proposed Changes

I've opened this issue to propose adding a CONTRIBUTORS file, and making it clear that replication of the file is a condition of compliance with the license. Everyone who contributes or has contributed to NetBox in some substantial way (e.g. more than fixing a typo) will have the option of adding his or her name or pseduonym (and possibly email address?) to the file.

I'm proposing this change just in case some external entity decides to fork NetBox and blow away the entire git history, wiping out years of attributions to hundreds of individual contributors, and making it appear as if the related work was all their own. Again.

As for previous contributors, we can try reaching out to those with substantial contributions in the past couple of years to see if they want to add themselves. We could start off with a gist to limit noise in the project initially. I don't want to take the liberty of adding anyone without their knowledge out of respect for their privacy.

(Incidentally, we had discussed this very idea years back, but concluded that maintaining a CONTRIBUTORS file was largely redundant since GitHub already does a fantastic job of this natively.)

Originally created by @jeremystretch on GitHub (Feb 25, 2021). ### Change Type [x] Addition [ ] Correction [ ] Deprecation [ ] Cleanup (formatting, typos, etc.) ### Area [ ] Installation instructions [ ] Configuration parameters [ ] Functionality/features [ ] REST API [ ] Administration/development [x] Other ### Proposed Changes I've opened this issue to propose adding a `CONTRIBUTORS` file, and making it clear that replication of the file is a condition of compliance with the license. Everyone who contributes or has contributed to NetBox in some substantial way (e.g. more than fixing a typo) will have the option of adding his or her name or pseduonym (and possibly email address?) to the file. I'm proposing this change just in case some external entity decides to fork NetBox and blow away the entire git history, wiping out years of attributions to hundreds of individual contributors, and making it appear as if the related work was all their own. Again. As for previous contributors, we can try reaching out to those with substantial contributions in the past couple of years to see if they want to add themselves. We could start off with a gist to limit noise in the project initially. I don't want to take the liberty of adding anyone without their knowledge out of respect for their privacy. (Incidentally, we had discussed this very idea years back, but concluded that maintaining a `CONTRIBUTORS` file was largely redundant since GitHub already does a fantastic job of this natively.)
adam added the type: documentationpending closurestatus: under review labels 2025-12-29 18:38:08 +01:00
adam closed this issue 2025-12-29 18:38:08 +01:00
adam commented 2025-12-29 18:38:08 +01:00
Author
Owner
Copy Link

@ypid commented on GitHub (Feb 26, 2021):

I'm proposing this change just in case some external entity decides to fork NetBox and blow away the entire git history

With this background maybe https://reuse.software/ could be interesting. Using it, a CONTRIBUTORS file could be generated. It will also handle the case that the generated file will only list people with bigger contribution because fixing a typo does not justify a copyright entry.

And not to mention the main advantage https://reuse.software/ brings. Clear and machine readable licensing.

@ypid commented on GitHub (Feb 26, 2021): > I'm proposing this change just in case some external entity decides to fork NetBox and blow away the entire git history With this background maybe https://reuse.software/ could be interesting. Using it, a `CONTRIBUTORS` file could be generated. It will also handle the case that the generated file will only list people with bigger contribution because fixing a typo does not justify a copyright entry. And not to mention the main advantage https://reuse.software/ brings. Clear and machine readable licensing.
adam commented 2025-12-29 18:38:09 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Feb 26, 2021):

Interesting idea, however there is also:

Perhaps we enable one of those.

@DanSheps commented on GitHub (Feb 26, 2021): Interesting idea, however there is also: * https://github.com/marketplace/actions/list-contributors * https://github.com/marketplace/actions/contributors-list * https://github.com/marketplace/actions/contributor_list * https://github.com/marketplace/actions/auto-add-contributors * https://github.com/marketplace/actions/contribute-list Perhaps we enable one of those.
adam commented 2025-12-29 18:38:09 +01:00
Author
Owner
Copy Link

@cpmills1975 commented on GitHub (Feb 27, 2021):

Reading through the change proposal I was wondering whether this could be generate automatically from a PR - I'm not a GitHub expert.

@cpmills1975 commented on GitHub (Feb 27, 2021): Reading through the change proposal I was wondering whether this could be generate automatically from a PR - I'm not a GitHub expert.
adam commented 2025-12-29 18:38:09 +01:00
Author
Owner
Copy Link

@TheNetworkGuy commented on GitHub (Mar 1, 2021):

I don't think generating this file automatically is an option. Jeremy explicitly mentioned the privacy of contributes. When you start auto generating this file its either all or none.

@TheNetworkGuy commented on GitHub (Mar 1, 2021): I don't think generating this file automatically is an option. Jeremy explicitly mentioned the privacy of contributes. When you start auto generating this file its either all or none.
adam commented 2025-12-29 18:38:09 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 1, 2021):

Regarding privacy, I just don't want to retroactively add everyone without their consent. It's probably okay to automatically add contributors moving forward provided we communicate that clearly. Though it does raise the issue of how to credit contributors (GitHub name vs. real name), and whether people will be able to opt out.

@jeremystretch commented on GitHub (Mar 1, 2021): Regarding privacy, I just don't want to retroactively add everyone without their consent. It's probably okay to automatically add contributors moving forward provided we communicate that clearly. Though it does raise the issue of how to credit contributors (GitHub name vs. real name), and whether people will be able to opt out.
adam commented 2025-12-29 18:38:09 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Apr 16, 2021):

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 (Apr 16, 2021): 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).
adam commented 2025-12-29 18:38:09 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (May 2, 2021):

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.

@github-actions[bot] commented on GitHub (May 2, 2021): This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label pending closure status: under review type: documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#4601
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?