ecosyste-ms / roadmap

Planning and roadmap for future Ecosyste.ms development
GNU Affero General Public License v3.0
13 stars 1 forks source link

Feature Request - Copyright Information #12

Open ben-harris-snyk opened 1 year ago

ben-harris-snyk commented 1 year ago

title: Feature Request - Copyright Information labels: enhancement assignees: andrew & chris48s

Feature Request

Description:

I would like to request the addition of a new feature related to copyright information in the Ecosystems project. This feature would enhance the project's utility by providing insights into the copyright status of open-source software and its components.

Details:

  1. Copyright Notices: The tool should be able to identify copyright notices within the code and display them to users. Where multiple copyright notices exist these should also be made clear, and if possible the dominant copyright be distinguishable from second-order copyright notices. This is essential for compliance and transparency.

  2. Copyright Analysis: The proposed feature should allow users to understand and view copyright-related information for open-source software, including details on the licenses used, copyright holders, and any copyright notices within the codebase. A potential bonus point here could be to enable users to read the copyright text in full, given how much more unique and non-standardised copyright information can be in comparison to license text.

  3. Integration: It would be beneficial if this feature could be integrated with existing data and APIs provided by Ecosystems.

Use Case:

This feature will be particularly useful for developers, researchers, and organizations looking to ensure compliance with open-source licenses and copyright requirements. It can also help identify potential licensing & copyright conflicts and provide transparency in the use of open-source software.

Implementation Thoughts:

While I'm not an expert in the Ecosystems project's architecture, here are some high-level thoughts that might help the implementation of this feature:

Considering that Copyright Information can sometimes be found in one of, or several of, multiple locations, such as the README.md, CopyrightNotice.txt, and the LICENSE.txt files. An example of this being present in all three can be found in npmjs.org : tslib at the following link: https://packages.ecosyste.ms/registries/npmjs.org/packages/tslib Other packages may only include one of the three, such as in the README.md found in npmjs.org : ansi-regex at the following link: https://packages.ecosyste.ms/registries/npmjs.org/packages/ansi-regex?path=license Due to this, it's possible that a similar logic pattern found in the Licences capabilities within the ecosyste-ms project could be applied in this area against the data already held within the project.

Additional Information:

This feature aligns with the Ecosystems project's mission to support, sustain, and secure critical digital infrastructure. It enhances the project's utility and provides valuable copyright-related information to users.

Thank you for considering this feature request. Please let me know if you require any further information or clarification.

Note: If you need more context or have any questions about this feature request, feel free to reach out. I'm happy to provide additional details.

Upvote & Fund

Fund with Polar

andrew commented 1 year ago

@ben-harris-snyk thanks for opening this, I think it would be a great feature to have, we'll definitely be adding it to the roadmap