Project portfolio clarifications

[ChooJeremy]

I would like to ask for clarifications regarding the project portfolio. For these sections, my CS2101 tutor deferred to CS2103 as she said that these section's content were not graded by her.

• For the Code contributed section, it says [Functional code] [Test code] {give links to collated code files}
  • I'm not sure what specifically to put here. Do I put links to the code files that I modified? I modified over 30 files, do I link to all of them?
• For the Project Management section in other contributions, is it OK to talk about how I set up the project on GitHub, managed releases, tags, auto-publishing of docs, travis CI, RepoSense etc?
• For the enhancements to existing features, do I ever duplicate what I have for my minor enhancement? If my minor enhancement is referring to an enhancement to an existing feature, where should that go?
• Is it OK to have something like "All my PRs have referenced clearly to which issues they're attempting to resolved and have resulted in no loss of code coverage"? Or is this more like "this is the expected standard and I shouldn't even be saying this is special"?
• Is there any required ordering in the Other contributions sections? (i.e. alphabetical)?

[CrimsonAng]

Hi,

[For the Project Management section in other contributions, is it OK to talk about how I set up the project on GitHub, managed releases, tags, auto-publishing of docs, travis CI, RepoSense etc?]

extracted from https://nus-cs2103-ay1718s2.github.io/addressbook-level4/team/johndoe.html

there is:

also from week 7 from the website:

I believe it is ok to mentioned those, but would be best if Prof/TA could verify.

[damithc]

For the Code contributed section, it says [Functional code] [Test code] {give links to collated code files}

• I'm not sure what specifically to put here. Do I put links to the code files that I modified? I modified over 30 files, do I link to all of them?

This part is outdated. I'll update it today.

@CrimsonAng is correct.

Minor enhancements are not graded but you are welcome to explain it in the PPP.

• Is it OK to have something like "All my PRs have referenced clearly to which issues they're attempting to resolved and have resulted in no loss of code coverage"? Or is this more like "this is the expected standard and I shouldn't even be saying this is special"?

No harm mentioning it as not all students maintain good PR hygiene.

• Is there any required ordering in the Other contributions sections? (i.e. alphabetical)?

No. You can put more impressive ones on top.

Let me know if I missed anything.

[ChooJeremy]

Thanks for the clarifications!

I have another question.

In the portfolio, it is required to include sections in the UserGuide and DeveloperGuide that I have worked on. The John Doe.adoc example uses the following method: include::../UserGuide.adoc[tag=dataencryption]

This works on IntelliJ with it's AsciiDoc plugin (it automatically displays the relevant portion directly into the portfolio but only shows a link on github. Is there a proper way to have it work on github as well?

[damithc]

This works on IntelliJ with it's AsciiDoc plugin (it automatically displays the relevant portion directly into the portfolio but only shows a link on github. Is there a proper way to have it work on github as well?

@ChooJeremy Instead of checking the .adoc source files on GitHub, check the corresponding .html file in your published web site.

[CrimsonAng]

https://github.com/CS2103-AY1819S1-F10-1/main/blob/master/docs/team/GITHUBUSERNAME.adoc

take the GITHUBUSERNAME and edit the link below

https://cs2103-ay1819s1-f10-1.github.io/main/team/GITHUBUSERNAME.html

can't seem to see your username.adoc so can't try out for you

edited:

actually not sure if need GITHUBUSERNAME, though what I see is people generally use the github username for the team/xxx.adoc

[aaditkamat]

For the Code contributed section, it says [Functional code] [Test code] {give links to collated code files}

• I'm not sure what specifically to put here. Do I put links to the code files that I modified? I modified over 30 files, do I link to all of them?

I have put the links to the specific PRs for the command that I added as part of the Functional code and the link to the test class for the command as part of the Test code for each of the two enhancements listed. I would like to check if this is fine?

For the enhancements to existing features, do I ever duplicate what I have for my minor enhancement? If my minor enhancement is referring to an enhancement to an existing feature, where should that go?

I would think that the enhancement could be explained in three portions:

1. what the functionality of the original command was
2. what the command now does
3. what were the modifications done (explained at a higher-level with no code involved).

[ghost]

https://github.com/CS2103-AY1819S1-F10-1/main/blob/master/docs/team/GITHUBUSERNAME.adoc

take the GITHUBUSERNAME and edit the link below

https://cs2103-ay1819s1-f10-1.github.io/main/team/GITHUBUSERNAME.html

can't seem to see your username.adoc so can't try out for you

edited:

actually not sure if need GITHUBUSERNAME, though what I see is people generally use the github username for the team/xxx.adoc

@CrimsonAng Because I am not from team f10-1

and by GITHUBUSERNAME I mean like,, for example,, yours (it would be CrimsonAng.adoc)

[CrimsonAng]

https://github.com/CS2103-AY1819S1-F10-1/main/blob/master/docs/team/GITHUBUSERNAME.adoc take the GITHUBUSERNAME and edit the link below https://cs2103-ay1819s1-f10-1.github.io/main/team/GITHUBUSERNAME.html can't seem to see your username.adoc so can't try out for you edited: actually not sure if need GITHUBUSERNAME, though what I see is people generally use the github username for the team/xxx.adoc

@CrimsonAng Because I am not from team f10-1

and by GITHUBUSERNAME I mean like,, for example,, yours (it would be CrimsonAng.adoc)

oh, i used team f10-1 because the original poster is from f10-1 so I paste the link there for him/her to try

yours should be https://cs2103-ay1819s1-f11-1.github.io/main/team/heartofal1on.html if i never referenced the name-of-document or team number wrongly,

yeah, but i used all small-caps for the a.doc cuz the original johndoe.adoc all small caps

Edit: It seemed the name of the .adoc can be anything? but I used github username

[ChooJeremy]

https://github.com/CS2103-AY1819S1-F10-1/main/blob/master/docs/team/GITHUBUSERNAME.adoc

take the GITHUBUSERNAME and edit the link below

https://cs2103-ay1819s1-f10-1.github.io/main/team/GITHUBUSERNAME.html

can't seem to see your username.adoc so can't try out for you

edited:

actually not sure if need GITHUBUSERNAME, though what I see is people generally use the github username for the team/xxx.adoc

Thanks, I've got it working. Mine is still in a PR so it's not merged yet, but I've verified that the link works correctly with a teammate's portfolio.

[damithc]

Guys, I updated the PPP description to remove some kinks and streamline with the sample given. Pleae have another look if you read it earlier.

[ghost]

https://github.com/CS2103-AY1819S1-F10-1/main/blob/master/docs/team/GITHUBUSERNAME.adoc take the GITHUBUSERNAME and edit the link below https://cs2103-ay1819s1-f10-1.github.io/main/team/GITHUBUSERNAME.html can't seem to see your username.adoc so can't try out for you edited: actually not sure if need GITHUBUSERNAME, though what I see is people generally use the github username for the team/xxx.adoc

@CrimsonAng Because I am not from team f10-1 and by GITHUBUSERNAME I mean like,, for example,, yours (it would be CrimsonAng.adoc)

oh, i used team f10-1 because the original poster is from f10-1 so I paste the link there for him/her to try

yours should be https://cs2103-ay1819s1-f11-1.github.io/main/team/heartofal1on.html if i never referenced the name-of-document or team number wrongly,

yeah, but i used all small-caps for the a.doc cuz the original johndoe.adoc all small caps

Edit: It seemed the name of the .adoc can be anything? but I used github username

Wow didn't know the contributions can be updated automatically. So cool man~ :D

[ChooJeremy]

I have another question relating to the page limits defined in the project portfolio deliverable. In there, it says that Overview + Summary of contributions should span at most 1 page. This seems far too arbitrarily low. The example given (johndoe.adoc) already spans slightly less than 2 pages when I export to pdf. Mine (and I believe, most students), will probably add some more information, and their content might well hit 2 pages or exceed it. The overview and major enhancement itself easily takes up the first page, leaving no space at all for other contributions.

Could it be possible to relax the restriction? Have no limit on all sections, as long as it totals up to 10 pages or less?

[damithc]

Could it be possible to relax the restriction? Have no limit on all sections, as long as it totals up to 10 pages or less?

Yes, that's fine.