feat: add a prototype for the Guild Loot Tracker lab

[Sebastian-Wlo]

Checklist:

• I have read freeCodeCamp's contribution guidelines.
• My pull request has a descriptive title (not a vague title like Update index.md)

Relates to: freeCodeCamp/freeCodeCamp#64119

• link to the related issue: Lab – Guild Loot Tracker freeCodeCamp#64119 ,
• currently, the prototype uses for() loops and Array.prototype.sort() method,
• I couldn't figure out how to use "Object.values()" in the functions (maybe adding a function returning the sums of ingredient macros to the requirements would be a good place to implement it?)

[jdwilkin4]

Please make to include the user stories so those can be review too just in case updates need to be made there.

Also, please let us know where this falls in the curriuclum.

loops module?
review modules?
higher order functions?

we will need that information when conducting reviews 👍🏾

[Sebastian-Wlo]

Just to make sure: should the user stories be a copy of those mentioned in the related issue, or should I come up with some new ones?

As for where this lab should be placed in the curriculum - originally, it was supposed to be in the Objects module. But I think listTopIngredients(), which was supposed to return sorted output requires the use of a loop. sort() would be ideal, but it should be doable with just a for() loop (I'd definitely need to make some changes to make it work).

So, Loops would probably be the right place for it.

Thank you, I'll add the user stories as soon as I can.

[majestic-owl448]

you can use those from the issue as base, and update as needed based on changes that have been made

[Sebastian-Wlo]

Sorry! I tried to rename the branch without thinking what it would do to the PR.

user-stories.md has been added

[majestic-owl448]

wouldn't this project have a similar issue to the nutrient tracker that we are replacing because potentially triggering?

[Sebastian-Wlo]

wouldn't this project have a similar issue to the nutrient tracker that we are replacing because potentially triggering?

Possibly, in the current form at least - someone actually pointed it out after I chose the issue.
It's possible that I misinterpreted the response, but the way I understood it was that this could still be useful, but maybe after changing its subject.

I'm not sure if it means I should come up with a different theme (I'm not the most creative person out there, so it might take some time), or leave the prototype as if for now and wait for a review.

[majestic-owl448]

there are many other things that could be tracked in a pretty similar way, so the prototype is still good, there will be need to change the name of some things before it's ready tho

[Sebastian-Wlo]

The overall "theme" has been changed to a new one (thank you once more @naomi-lgbt, if it wasn't for you, I would have been stuck at coming up with something for some time).

It will definitely need changes, since getMemberTotals() is the only function that returns a string while the other return objects (incidentally, it is unfortunately the only point where I managed to find a use for Object.values() in). I hope that at least one approach is good, and can be applied to the rest of the functions.

Should I request another review for this?

[jdwilkin4]

I left some thoughts on the user stories.
But also noticed that none of these functions are being used anywhere.

From an educational standpoint, we don't want to send the message to beginners to create functions in their code and not use it. All of these functions should be used in some way so campers can connect the dots and see what is actually happening in the code. Even if it is just logging these function call results to the console.

[jdwilkin4]

Also, please update your PR title since the project was changed 👍🏾

[Sebastian-Wlo]

But until that can happen, we won't be able to add this lab to the curriculum because we can't ask campers to build projects on topics they haven't learned yet. And this lab seems to be solely dedicated to practicing those methods mentioned earlier.

That's fair - I've been trying to make the prototype work without these methods, and while it could be done, it felt like it wasn't introducing anything that wasn't already shown in the labs for the loops. It also felt more "awkward" than it probably should, if that makes sense, but I wasn't sure if that was because the lab's description didn't really fit that section, or if it was just me doing a bad job of it.

So you will need to reach out to Naomi on next steps. Either we are going to wait until the new lesson has been added so this lab can be added. Or not add this new lab at all.

I'll do that, thank you!

[jdwilkin4]

@Sebastian-Wlo

What's the status for this lab?

[Sebastian-Wlo]

@jdwilkin4
Sorry, forgot to forward it here - if I understood correctly, it might get turned into a workshop for using .entries(), .keys() and .values() at some point.

I haven't worked on it in a while, but I can try modifying the prototype to use these specific methods instead of loops so it would be ready to be divided into steps.

[jdwilkin4]

I would confirm with Naomi to see what next steps should be here 👍🏾

[Sebastian-Wlo]

I asked her a while ago, this is what she told me:

The only place we are using a loop is in that "listTopMembers" function.
What if we:

1. Change that to listMembers and just print the Object.entries or something simple.
2. That means we could put this in the objects section instead of the loops section, I think?
3. Which then means we could turn it into a workshop and teach those concepts there!

... which, had I read the response properly back then, I could have done a long time ago. I'll make the changes soon.

[Sebastian-Wlo]

Actually, as far as I understand, turning this lab into a workshop would probably require going through a completely different process - I'll ask Naomi how to do it properly and if I should create, or wait for, an issue about the lab.
Sorry, I've been a little distracted lately.

[majestic-owl448]

at the prototype stage, the main difference is that a workshop does not need user stories, and that the protytpe is the final solution of the project, not just a possible solution

[jdwilkin4]

@Sebastian-Wlo

Can you post any updates you have regarding this project?
Thanks 👍🏾

[jdwilkin4]

It looks like a quick glance there were recent conversations on discord regarding this. But those conversations can easily be burried.
So it is best to post an update here so we can track of the progress all in one place 👍🏾

[Sebastian-Wlo]

@jdwilkin4, Sorry for the lack of any activity!
I know that this will get turned into a workshop - so, I need to remove the remaining for() loop, make sure that the prototype is cleanly written and get rid of the user stories before planning out how to break the code into steps.
I'll do my best to update the prototype over the weekend, or in the worst case early next week.

[Sebastian-Wlo]

First of all, I'm really sorry it took me so long to add any updates.

I'm still not happy with the addLootEntry() and cloneGuildData() functions. I understand what purpose creating a shallow copy of the object is supposed to have, but it currently doesn't really add anything.
Another thing that doesn't seem right is the inconsistency between returning values and using console.log()s in the functions. I'm not sure which would work better - it seems like returning strings and logging them to the console would be the best solution, but I'm not sure if this makes the most sense here.

I hope to keep working on this, but I'd really appreciate any pointers on how to turn this into a actually useful workshop

[jdwilkin4]

@Sebastian-Wlo

it would probably be best to open up a thread on discord under naomi's sprints channel.
That way we can hash this out get more clarity on the core objectives for this lab.

[Sebastian-Wlo]

Terribly sorry it took so long! I've unfortunately been really busy.

Sorry the prototype is not up to an acceptable level. Aside from from all of the (too many) TODOs in the current version, are there any glaring mistakes that need to be addressed?

During the conversation in the Naomi's sprints channel it turned out that it's not clear the names I've used for the guild members are actually names (which I should have seen coming, to be honest).
I was thinking about using the names of the fCC staff, like it's been done in some of the previous workshops, but it didn't feel comfortable with assigning people reputation and experience arbitrarily. Would it be okay if I did that? I don't want anyone to be offended about the "stats" I'm assigning here

[jdwilkin4]

these names should work

let guild = {
  ethan: {
    gold: 31,
    silver: 48,
    reputation: 9,
    experience: 198,
  },
  elara: {
    gold: 78,
    silver: 64,
    reputation: 12,
    experience: 111,
  },
  brandon: {
    gold: 41,
    silver: 7,
    reputation: 7,
    experience: 70,
  },
  dylan: {
    gold: 81,
    silver: 2,
    reputation: 20,
    experience: 220,
  },
  lucas: {
    gold: 34,
    silver: 28,
    reputation: 10,
    experience: 179,
  },
  natalie: {
    gold: 36,
    silver: 81,
    reputation: 12,
    experience: 82,
  },
};

[jdwilkin4]

I was thinking about using the names of the fCC staff, like it's been done in some of the previous workshops, but it didn't feel comfortable with assigning people reputation and experience arbitrarily. Would it be okay if I did that? I don't want anyone to be offended about the "stats" I'm assigning here

I left a comment regarding the names. But in general, some of the staff would probably be fine having their names in the curriculum while others might not. So using fake yet more realistic names should be fine here.