search

sabrina-aip / spellcheck

a very silly spelling bee game
74 stars 36 forks source link

Project maintanance. #26

Open lexeyOK opened 5 months ago

lexeyOK commented 5 months ago

@sabrina-aip I understand that you made this project for the video and so haven't been able to properly set up all the "needed" things, but here are some suggestions. Some of them should probably be resolved or approved by you, but some can be done by others.

Licensing

Right now, this project has no LICENSE file, so even though you said in the video that people could freely share and use your code, this isn't stated in the project. GitHub has several license documents you can choose from, just try to add the file with the name LICENSE. One popular license is MIT. It allows anyone to do anything with your code (probably what you wanted). There might be troubles with that part as you used AI to generate definitions and audio for them there might be problems with licensing this, but I don't know about that (not a lawyer).

.gitignore

You should set up a .gitignore file for this project as currently, your project has .DS_Store files (internal macOS files) in the repository (whey should not be here). There is a repository https://github.com/github/gitignore with many .gitignore files. You probably want to set up a so-called Global ignore file so it will affect all git repositories on your system macOS.gitignore. GitHub guide on gitignores.

audio files

There are a lot of audio files for this project. Although git LFS allows storing big binary files, they probably shouldn't be shown in the repository, as it is slowing down GitHub's tree view. Potentially you can make a zip archive with all audio files with instructions on how to set up them or let them be as is.

GitHub pages?

GitHub provides free hosting of static pages, which seems to be the case for this site (but I don't know if it will work). It can even use the domain name provided by you.

Nuttall_s_spelling_bee_guide_condensed_f.pdf file

probably an error (doesn't seem to be used on the site) and should be removed if not needed If it is needed probably should add a link to it in the readme as a citation.

jasger9000 commented 5 months ago

Concerning the .gitignore #27 has a commit removing the .DS_STORE files.

applecuckoo commented 5 months ago

hey! Yes, I made PR #27. Seems like two of Sabrina's AIP projects are licensed: the pi game is licensed under the Unlicense and 'quick-maffs' is licensed as CC0 Public Domain. Just wanted to pop that in :)