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

Clarify formatting errors of history files upon validation #1055

Open
MattiSG opened this issue Feb 16, 2024 · 6 comments
Open

Clarify formatting errors of history files upon validation #1055

MattiSG opened this issue Feb 16, 2024 · 6 comments

Comments

@MattiSG
Copy link
Member

MattiSG commented Feb 16, 2024

As seen in OpenTermsArchive/pga-declarations#235 and OpenTermsArchive/pga-declarations#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
Copy link

gnaaruag commented May 8, 2024

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 MattiSG removed the good first issue Good for newcomers label May 8, 2024
@MattiSG
Copy link
Member Author

MattiSG commented May 8, 2024

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
Copy link

gnaaruag commented May 8, 2024

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
Copy link
Member Author

MattiSG commented May 8, 2024

Of course, you're welcome to try! 👍 However, we will unfortunately not be able at this time to provide proper guidance for a new contributor. You can find more information on #832 (comment).

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

@gnaaruag
Copy link

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
Copy link
Member Author

MattiSG commented May 13, 2024

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!

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

No branches or pull requests

2 participants