Added scores.yml

[VamsiSangam]

Adding empty scores.yml. This is for the rankings as discussed with @gauthamzz in #64 . After this merge, I will create a new issue asking students to add details of their contributions into this file.

[gauthamzz]

can you add all students name as well in the file

[VamsiSangam]

Ok sure. Just the names, or any other details as well?

[VamsiSangam]

I was planning to have each student's name, image, github username attributes along with the mandatory total and contributions fields.

[VamsiSangam]

I was thinking each student would have details listed out in this fashion -

- name: Vamsi Sangam
  image: vamsisangam.jpg
  github: VamsiSangam
  contributions:
    - name: Added profile to students
      link: https://github.com/fossiiita/opencodecollab/pull/7
      score: 30
    - name: Enable gh-pages on your fork
      link: https://github.com/fossiiita/opencodecollab/issues/15#issuecomment-273281903
      score: 30
  total: 60

image and github fields would help while displaying candidate's pic on the leaderboard.

[gauthamzz]

yeah this looks better , i fear the file will get too large

[VamsiSangam]

I don't think it can be helped if you want to store all the contributions

[Anupam-dagar]

So after every successfull pull reuqest, we will have to add the data in this file. Right?

[VamsiSangam]

Yes that's the plan

[gauthamzz]

i think its better to have a contributions.yml file with student name , but this work too

@adeora7 @shubham-padia what do you guys say ?

[adeora7]

could you please elaborate. You mean one file for each student ? @gauthamzz

[shubham-padia]

Instead we can have the students list out the breakdown of points and link of all pull requests in a separate gist file and give a link to that file. Participants will have to change the total with each pull request and update the gist accordingly

[gauthamzz]

i mean like make a file points.yml
and in it

• student name
  contributions:
  • name: Added profile to students
    link: Added profile to students #7
    score: 30
  • name: Enable gh-pages on your fork
    link: Enable gh-pages on your fork #15 (comment)
    score: 30
    total: 60

will be there or should we jsut add it in students.yml

[gauthamzz]

i like @shubham-padia 's idea

[VamsiSangam]

@shubham-padia 's idea sounds nice. But then all the gists need to have a fixed format, JSON perhaps. But still, if it is a gist, we would lose control over the list of contributions. The participant may/may not update them, or the participant may follow different format.

[VamsiSangam]

And a gist is more of an individual thing, it seems like we separating an event related entity from the event itself.

[gauthamzz]

we need to figure out a solution fast :/

[VamsiSangam]

If we have contributions in the .yml, later on while implementing the leaderboard, we can easily list out a candidate's total and contributions using simple loops... If we have it in a separate gist, we would need to load it via AJAX. And because we would have to load it asynchronously I said we would need the gists to be in JSON. And we can't monitor each candidate's gists. If one candidate messes up their gist, their contributions may not get displayed, and we'd probably have to PM them. I'm just saying having contributions in .yml may make it big but the further implementation is neat.

[gauthamzz]

you are right @VamsiSangam but if we write everything in students.yml small changes may cause it to break. thats why thought of having a seperate yml file. a simple loop will also work in this case.

[VamsiSangam]

I never meant to put everything in students.yml . My plan was to create scores.yml which has the contributions, total score, name and username & image (just for display purposes). So this is what would go into scores.yml -

- name: Vamsi Sangam
  image: vamsisangam.jpg
  github: VamsiSangam
  contributions:
    - name: Added profile to students
      link: https://github.com/fossiiita/opencodecollab/pull/7
      score: 30
    - name: Enable gh-pages on your fork
      link: https://github.com/fossiiita/opencodecollab/issues/15#issuecomment-273281903
      score: 30
  total: 60

That's for me, everyone would list out theirs. It will make it big, but it is separation of concerns. Details of students in students.yml and contribution (which includes scores) in scores.yml

[gauthamzz]

i think we shouldnt have duplicate data. i think github username will be sufficient and we can pick up others from the students.yml file

[VamsiSangam]

Ok then this is what would go into scores.yml -

- github: VamsiSangam
  contributions:
    - name: Added profile to students
      link: https://github.com/fossiiita/opencodecollab/pull/7
      score: 30
    - name: Enable gh-pages on your fork
      link: https://github.com/fossiiita/opencodecollab/issues/15#issuecomment-273281903
      score: 30
  total: 60

Is this what you meant?

[gauthamzz]

github id will be like a primary key , yeah exactly

[VamsiSangam]

Ok we will wait for what @shubham-padia and @adeora7 have to say about this. Meanwhile, let's say I have my primary key value, say VamsiSangam, and to search its data in students.yml, should I just loop over the file or is there any construct which helps me do that?

[gauthamzz]

https://jekyllrb.com/docs/datafiles/

[shubham-padia]

#125 (comment) Sounds good. Implement it for now, if we face any issues with this approach we can always change it 😛

[VamsiSangam]

Please review the format. If everything's okay, after the merge I will create an issue asking others to fill in their contributions.