OpenTermsArchive / engine

Tracks contractual documents and exposes changes to the terms of online services.
https://opentermsarchive.org
European Union Public License 1.2
105 stars 29 forks source link

Clarify formatting errors of history files upon validation #1055

Open MattiSG opened 4 months ago

MattiSG commented 4 months ago

As seen in https://github.com/OpenTermsArchive/pga-declarations/pull/235 and https://github.com/OpenTermsArchive/pga-declarations/pull/236, when running validation on improperly formatted history files, the error message is impossible to understand:

 Uncaught error outside test suite:
     Uncaught TypeError: history[entry].sort is not a function

The validation should be clearer and yield a message similar to:

History file does not have the expected structure. Each term type should be declared within an array, rather than an object.

Similar to #832.

gnaaruag commented 1 month ago

hello there, i'm relatively new to open source and think this is a good issue for me to get started. can i work on this/get this issue assigned?

MattiSG commented 1 month ago

Thanks @gnaaruag for offering your help! 😃 While this issue is good for newcomers to the codebase, it probably is not easy enough to get started with as a first contribution to open source. I removed the label. Could you tell us where you spotted this issue and what led you to this repository? 🙂

gnaaruag commented 1 month ago

i was browsing the github education's section on open source repos one can contribute to and i really found this project to be interesting work. you do mention its probably not a good issue to get started with but can i still give it a shot?

MattiSG commented 1 month ago

Of course, you're welcome to try! :+1: However, we will unfortunately not be able at this time to provide proper guidance for a new contributor. You can find more information on https://github.com/OpenTermsArchive/engine/issues/832#issuecomment-1116069754.

Please also kindly note that we will not accept AI-generated pull requests.

gnaaruag commented 1 month ago

hey! thanks, ill spend a little while getting familial with the repo and then try to solve it. also do you guys have a discord server perchance?

MattiSG commented 1 month ago

We don't use Discord but have a Mattermost for contributors 🙂 Let's keep GitHub to discuss work on this issue so we have public traces!