Project submission / solution naming #4069
Replies: 12 comments
-
I don't feel super strongly about this either way, but I think it would be good to be consistent. A few thoughts:
For those reasons I'd go with submission if we wanted to be consistent, but not a hill I'd die on |
Beta Was this translation helpful? Give feedback.
-
Thanks @ChargrilledChook, great points 👏 I've been giving this way more thought than it really deserves the past couple of days 😂 I've been landing on solution probably being the more accurate domain name - "a user submits their solution for a project" kind of thing. Tracing things back, I think submission came from when users had to submitt PRs to add their projects. We called them project submissions internally within the team and that terminology found its way into the feature. But learners almost always refer to them as solutions based on some Discord searching. I also had a look at what other platforms are calling this kind of thing. Codementor is probably the closest to our project feature, but I looked at FCC, Exercism, Codewars and others too. "Solution" is prevalent across them all. Although, I do agree a lot with what you're saying about it feeling odd for larger projects. I wish there was something better, something cooler lol we could use. And you're not wrong about the PR to change it being a pain, it's going to be big 😬 |
Beta Was this translation helpful? Give feedback.
-
I agree with Chook. Especially that I wouldn't consider bigger projects a "solution". Between those two, I'd vote "submission" Alternatives:
|
Beta Was this translation helpful? Give feedback.
-
While I agree that between solutions and submissions is the better, I still think submissions seems to suggest that you are like submitting it for review? In that way I could see just a plain |
Beta Was this translation helpful? Give feedback.
-
I wish we could use plain project/s. But within the overall system, project is as good as a reserved word - it's the project itself.
That sums up my problem with submissions - it implies it's a proposal that needs some action like a review or judgement after it's been submitted. I do agree solutions doesn't accurately describe bigger projects for the learner outside of TOP. Hopefully, for them they are portfolio pieces. But it is pretty accurate within the context of a project page. Any items in the list are community solutions for the project. Having spent way too much time obsessing over what to name things in my career lol - one of the things I've learnt is in the absence of a completely bullet proof name. The next best thing is going with what most people are already calling it. On Discord at least, thats solutions by a significant margin. Edit: Just to clarify, this renaming would be across the entire stack, from the database to the html. We can maybe deviate a little on the frontend like Chook mentioned. But we're looking for the right name to describe this resource within the overall system. |
Beta Was this translation helpful? Give feedback.
-
Personally feel like "solutions" is more apt to things like our exercise repos. "Here's my solution to solve this exercise." While submissions feels a little more apt to projects, since it's not really "Here's my solution to this project." Either way there's going to be some unintended connotation to either word. "Well solution implies we're solving a problem when we're just creating something"/"Submission sounds like we're waiting for review". And we can just as easily convey our intent for either word. I do like Manon's suggestion of just "project". The only possible issue with that is there might be some Ruby "projects" that are more akin to exercises? Things like the basic ruby projects. Though that could open another can of worms - should those "projects" actually be part of a Ruby exercise repo instead (not sure if this is something already in the works/discussed so the Team Magma people will have to chime in here). |
Beta Was this translation helpful? Give feedback.
-
From what I understand, using the word |
Beta Was this translation helpful? Give feedback.
-
I still think that if we restrict ourselves to just |
Beta Was this translation helpful? Give feedback.
-
I agree with Manon's suggestion regarding the term |
Beta Was this translation helpful? Give feedback.
-
What about 'User Project' for non-exercise submissions (tic-tac-toe) and "User Exercise" for user exercises like the css exercise repo? |
Beta Was this translation helpful? Give feedback.
-
I'd vote for Or I'm in Node/JS path and I do feel the word 'project' is reserved for projects like to-do list, weather-app etc, but I guess it's different in the Ruby path. |
Beta Was this translation helpful? Give feedback.
-
Converted this to a discussion as it's not actionable yet. Sorry, I framed the original question incorrectly, my intention was to land on a naming scheme we could use throughout the whole stack not just that specific part of the UI in the screenshot. But I definitely see how it looks that way now. I'm leaning towards solutions for the backend and db. Within the overall system that makes sense, "a project has many solutions". But we can use something more human readable on the UI. User/completed/finished projects are what I've personally liked best from the suggestions so far. While I agree not everything is big enough to be labelled a project, I don't think we should go the trouble of having different labelling for different sized projects for this. That would mean we'd have to get into giving projects sizes and thats just slightly out of scope what we're trying to achieve here. But that could be a good follow up thing we could do in the future. |
Beta Was this translation helpful? Give feedback.
-
We're using both project submission and project solution interchangeably throughout the codebase to describe user projects.
Such as here lol:
This isn't a huge problem, but it's always a good idea to be consistent. So which should it be?
Beta Was this translation helpful? Give feedback.
All reactions