Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds open source licenses (fixes #2941) #3982

Open
wants to merge 28 commits into
base: master
Choose a base branch
from

Conversation

alexzvk
Copy link

@alexzvk alexzvk commented Dec 6, 2022

Description

My EECS 481 final project. Takes the pull request from @Andrew-Chen-Wang (who I have been in contact with) that fixes #2941 and implements suggestions on said pull request.

  • Adds a script check_licenses.py which iterates through all licenses and prints any instances of placeholders for cookie-cutter project data that have not been reformatted to accept said project data.
  • Adjusts update_licenses.py to store a mapping of license names to file titles to a dictionary, found in a json file in the project slug's "licenses" folder. This reduces the time complexity of the previous solution, which involved looping through all of the possible licenses, and also removes the need to include Jekyll headings (though they have not been removed)

Note that the build works locally for me, but I was not able to pass all of the automated checks. While there remains much I want to work on... the end of the semester looms and I must make a pull request to receive credit.

Checklist:

  • I've made sure that tests are updated accordingly (especially if adding or updating a template option)
  • I've updated the documentation or confirm that my change doesn't require any updates
    In line with the previous pull request: not sure if it's worth putting all of the licenses in the documentation.

Rationale

Fixes #2941
Makes it easier to maintain having many options for open-source licenses since a script can be run that pulls them all from a maintained github repository

alexzvk and others added 28 commits November 26, 2022 17:42
…ictionary in update_licenses.py and post_gen_proj.py to reduce time complexity
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add AGPL
1 participant