This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
gsoc:2025-gsoc-spdx [2025/02/14 07:42] till |
gsoc:2025-gsoc-spdx [2025/03/28 15:48] (current) VedantJolly2808 |
||
---|---|---|---|
Line 68: | Line 68: | ||
Create a web accessible tool for validating SPDX 3.0 documents. | Create a web accessible tool for validating SPDX 3.0 documents. | ||
+ | Size: Medium (175 hours) | ||
+ | |||
+ | Level of Difficulty: Hard | ||
+ | |||
Skills Needed: | Skills Needed: | ||
* Software development skills for Web based applications | * Software development skills for Web based applications | ||
Line 85: | Line 89: | ||
Available Mentors: John Speed Meyers, Gary O'Neall (gary at sourceauditor | Available Mentors: John Speed Meyers, Gary O'Neall (gary at sourceauditor | ||
+ | dot com) | ||
+ | |||
+ | |||
+ | **Enhancing the Functionality of spdx-license-diff** | ||
+ | |||
+ | The [[https://github.com/spdx/spdx-license-diff|spdx-license-diff]] tool is a JavaScript-based web browser plugin that enables users to easily compare license text on a website with the contents of all licenses on the [[https://spdx.org/licenses/|SPDX License List]], generating percentage matches and differences. | ||
+ | |||
+ | |||
+ | spdx-license-diff requires updates to enable it to continue working with newer versions of Firefox and Chrome -- see https://github.com/spdx/spdx-license-diff/issues/121 and https://github.com/spdx/spdx-license-diff/issues/122 for example. | ||
+ | |||
+ | |||
+ | There are also several areas where its functionality could be extended, such as: | ||
+ | |||
+ | * More fully implementing the [[https://spdx.github.io/spdx-spec/v3.0.1/annexes/license-matching-guidelines-and-templates/|SPDX License List Matching]] Guidelines when performing matches | ||
+ | |||
+ | * Indicating which of several “alt” options for regular expressions is matched | ||
+ | |||
+ | * Other usability and functionality improvements | ||
+ | |||
+ | Size: Medium (175 hours) | ||
+ | |||
+ | Level of Difficulty: Medium | ||
+ | |||
+ | Skills Needed: | ||
+ | * Software development skills for Browser extensions | ||
+ | * Good user interface design skills | ||
+ | * Proficient in Javascript | ||
+ | |||
+ | Available Mentors: Vedant Jolly (vedantjolly2001 at gmail dot com), Rohit Lodha(rohit.lodhartg at gmail dot com), Gary O'Neall (gary at sourceauditor | ||
+ | dot com) | ||
+ | |||
+ | **Revamping and Enhancing the License List Website** | ||
+ | |||
+ | The [[https://spdx.org/licenses/|SPDX License List website]] is generated via the [[https://github.com/spdx/LicenseListPublisher|License List Publisher]] tool and populated from the [[https://github.com/spdx/license-list-XML/tree/main|SPDX License List XML]] files. The Publisher tool is written in Java. | ||
+ | |||
+ | |||
+ | The website could use some updates to its appearance and functionality to make it more modern and improve usefulness and accessibility such as: | ||
+ | |||
+ | * Filtering on the table of contents pages for more quickly finding licenses. Currently, there is JavaScript for sorting the different columns, but no other option to search or find licenses other than scrolling. | ||
+ | |||
+ | * Possibly a more advanced search option to enable searching on a specific text phrase, which would likely be implemented in the Python-based [[https://tools.spdx.org/app/|SPDX Online Tools]] | ||
+ | |||
+ | * Edits to the license page templates (HTML) to make visible the OSI and FSF approved data, and link to the license-list-xml GitHub location | ||
+ | |||
+ | * Improve readability and accessibility for displaying regular expressions corresponding to “alt text” sections (e.g. the red text in each license page). | ||
+ | |||
+ | * Consider user accessibility. | ||
+ | |||
+ | * Consider mobile view and page responsiveness. | ||
+ | |||
+ | * Design improvements and recommendations overall | ||
+ | |||
+ | Size: Medium (175 hours) | ||
+ | |||
+ | Level of Difficulty: Medium | ||
+ | |||
+ | Skills Needed: | ||
+ | * Software development skills for Web based applications | ||
+ | * Good user interface design skills | ||
+ | * Proficient in Java | ||
+ | |||
+ | Available Mentors: Rohit Lodha(rohit.lodhartg at gmail dot com), Vedant Jolly (vedantjolly2001 at gmail dot com), Gary O'Neall (gary at sourceauditor | ||
dot com) | dot com) | ||