search

i-am-bee / bee-agent-framework

The framework for building scalable agentic workflows
Apache License 2.0
69 stars 16 forks source link

copyright.sh could use some improvement for open source project #30

Open markstur opened 2 hours ago

markstur commented 2 hours ago

Describe the bug

There are 3 (debatable) problems with automatic adding of copyright with copyright.sh.

  1. Using "IBM Corp." in the copyright is not very open source community friendly. There are many opinions, but a good Linux Foundation suggestion is "Copyright The XYZ Authors." where XYZ is the project name (https://www.linuxfoundation.org/blog/blog/copyright-notices-in-open-source-software-projects)
  2. The one-line SPDX-License-Identifier is becoming preferred over text blobs to reduce the slight variations that happen in text blobs (potentially significant rewording).
  3. I got an error because "jq" was not installed. We can avoid that (or else it should be documented dev setup somewhere).

Maybe this debate was already settled, but I'm suggestion we make those changes. It looks like this would affect our other repos (same script to change).

TBD: Whether to change existing copyrights. I don't like touching existing copyrights, so I'd focus on fixing this for added files, but the project is new enough that updating copyrights from IBM to project authors, but be a good thing to do.

To Reproduce Steps to reproduce the behavior:

  1. Add a new file w/o copyright and license
  2. Commit it
  3. See the copyright/license header that was added (if you have jq)
  4. Also you could just look in our existing files already added

Expected behavior

  1. An open source community project should ideally have an open license and avoid individual person or company copyrights.
  2. A per-file license might be a best practice, but it can be abbreviated to be succinct and consistent
  3. New devs should not get "jq" not found errors when doing a commit (unless we add that to our contributing guide)

Screenshots / Code snippets If applicable, add screenshots or code snippets to help explain your problem.

Set-up:

Additional context Add any other context about the problem here.

Feel free to have opinions on this. The current process was probably leveraged from other projects. There's more than one way.

markstur commented 2 hours ago

/assign me