pintergreg / handout Goto Github PK

• Needs a crossplatforn, FOSS IDE
  • IntelliJ Rider: Free with student licence or the EAP can be used for free - seems like a trial
  • Students also needs to be able to use Visual Studio
  • VS Code can compile but only the MS build, the OSS Code cannot
    • it is very basic, not really convient
• document IDEs #19
• needs a crossplatform, FOSS GUI famework
  • http://avaloniaui.net/docs
    • https://ptupitsyn.github.io/Cross-Platform-DotNet-UI/
• Using .Net Core
• dependency management with nuget
• free code quality checker
• free code coverage tool
• ability to build and run tests on linux based CI environment
  • .NET core should provide this

Ref:

• https://stackoverflow.com/a/29631362/4737417
• 

• VS Code
• IntelliJ Rider
• VS

Maybe using this: https://github.com/hizzgdev/jsmind

quizdown seems to be suitable for the task.

Caveats:

• questions will be available in the markdown source with the correct answer
• questions will be available in the compiled HTML with the correct answer

Therefore, different question should be used as in the midterm pool.

https://stackoverflow.com/questions/64890960/how-can-i-add-the-net-framework-5-0-to-visual-studio-professional-2019

Mostly to Wiki pages and if possible, add preview

Reason: user stories should not contain implementation details.

I did mention this in the sprint 1 chapter, but not in the GH issue though.

"Transfered" from 2019-Fall

Related to #39

• port skeleton
• write about in in the reference architecture

"Transfered" from 2019-spring

Back then, a feature request has been sent to GH about defining branches from where PR review is not required. That's still not possible.

This will be solved with simplified branch strategy:

• only master is protected, not more two level reviewing
• draw figure to visualize
• add section to handout

Use the handout repo and this image as example.

sources:

• https://docs.saltstack.com/en/latest/topics/development/labels.html
• https://medium.com/@dave_lunny/sane-github-labels-c5d2e6004b63
• https://robinpowered.com/blog/best-practice-system-for-organizing-and-tagging-github-issues/

Using mdbook-toc based on this

• agile
• daily work
• tdd
• legacy code
• review
  • contains mainly links, not necessary
• ci
  • that chapter is like a presentation I think it is not necessary
• software architecture

• add DoD point describing World should be functional, it should be instantiated in the AutomatedCar project
  • not just a set of tools
  • rephrase correctly
• add triangle query
  • public
• add reference points
• rephrase hierarchical model
• draw structural figure about the model

• modell DoD-be beletenni a forgatást

• if currently the CI tools can run in private repos that set repos private
• if not, try to set issues and repo discussions private
  • issues cannot be private in a public repo, the workaround is not reasonable
• try to migrate to GitLab -> check if CI tools can cooperate with GL in a private repo (back to 1st point)
• or find alternative tools

Based on [this discussion](based https://github.com/orgs/SzFMV2020-Tavasz/teams/team-a3/discussions/3).

This is related to #3 and a part of #1

There are some figures that are relatively easy to (re)draw, but a local one is better than a remote one.

• TDD cycle
• test pyramid
• waterfall
• v-model
• blackbox-whitebox
• HIL
• SIL
• coordinate system
• centralized version control
• distributed version control
• and so on

The one mentioned here seems good enough: SzFMV2020-Tavasz/AutomatedCar-A/issues/62

IReadOnlyDummyPacket should be in AutomatedCar.SystemComponents.Packets namespace instead of global namespace.

Reporter: @tffbs

https://github.com/SzFMV2021-Tavasz/AutomatedCar-B/issues/1#issuecomment-795348166

• lectures/daily_work.md:236:28

  • gyakorlati oldalról lást Git fejezet

  • File not found: ./git.md
• lectures/daily_work.md:259:3
  • A fork és a branch közötti különbségekről
  • 404
• lectures/tdd.md:51:3

  • mockold a függőségeket

  • File not found: legacy_code.md/#Mocking
• lectures/ci.md:76:1

  • 

  • Server returned 403 Forbidden for https://s3-eu-west-1.amazonaws.com/elasticbeanstalk-eu-west-1-981246043789/wp-content/uploads/2018/09/21142911/Software-in-the-loop.png
• lectures/ci.md:82:1

  • 

  • Server returned 403 Forbidden for https://s3-eu-west-1.amazonaws.com/elasticbeanstalk-eu-west-1-981246043789/wp-content/uploads/2018/09/21142901/Hardware-in-the-loop.png
• lectures/ci.md:137:47

  • A statikus kódelemzést a Checkstyle végzi, ez lokálisan is működik, a változások követéséhez és mindenféle riport generálásához (első sorban a Pull Requestekhez) a CoceFactor.io van bekötve. Ez össze van linkelve a GitHubbal repóval, a commit triggerre saját környezetben kicsekkolja az aktuális branchet, lefuttatja a Checkstyle-t (és adott esetben más elemzőket is), majd elkészíti a riportokat.

  • File not found: TODO
• lectures/ci.md:141:118

  • A Java kódunk tesztekkel való lefedettségét a JaCoCo (Java Code Coverage) nevű szoftver számolja ki. Szintén működik lokálisan is, a CodeFactorhoz hasonló online riportgeneráló amit a repónkhoz beállítottam az a CodeCov. Az előbbivel analóg módon működik.

  • File not found: TODO
• lectures/ci.md:141:221

  • A Java kódunk tesztekkel való lefedettségét a JaCoCo (Java Code Coverage) nevű szoftver számolja ki. Szintén működik lokálisan is, a CodeFactorhoz hasonló online riportgeneráló amit a repónkhoz beállítottam az a CodeCov. Az előbbivel analóg módon működik.

  • error sending request for url (https://codecov.io/): error trying to connect: tcp connect error: Connection timed out (os error 110)
• github.md:150:3

  • A fork és a branch közötti különbségekről

  • error sending request for url (https://www.gitprime.com/the-definitive-guide-to-forks-and-branches-in-git/): error trying to connect: dns error: failed to lookup address information: Name or service not known
• github.md:195:210

  • A GH minden felhasználónak biztosít egy "proxy ímélcímet", hogy titokban tarthassa a címét, ez [email protected] szerkezetű, ahogy xxxxxxx egy hétjegyű felhasználói azonosító. Bővebben itt. Ezt is lehet használni, nem csak társszerzőhöz hanem saját címnek is, csak legyen konzisztens!

  • Server returned 404 Not Found for https://docs.github.com/articles/about-commit-email-addresses
• lectures/tdd.md:69:3

  • Refactoring Java Code

  • error trying to connect: dns error: failed to lookup address information: Temporary failure in name resolution
• lectures/tdd.md:105:3

  • Acceptance Test Driven Development (ATDD)

  • error trying to connect: dns error: failed to lookup address information: Temporary failure in name resolution

• 
• link szensors chapter in Camera section

https://docs.codecov.io/docs/codecovyml-reference

• Interfészt kell biztosítani a szenzorok látóterét jelképező háromszögek opcionális megjelenítésére
  • típusonként (radar, kamera, ultrahang) külön-külön kapcsolahatónak kell lennie és más-más színnel kell megjelnnie (piros, kék, zöld)

"Transfered" from 2019-spring

CodeFactor.io promised the two-level finding (warning-error) system is not used. I want it block the PR only with errors, not warnings.

This is still not working and CodeFactor.io has other issues, so it may be high time to drop it in favor of something else. Maybe a well-written GH Actions script can handle it on its own, but the reporting would be lost then...

• Create new GitHub Organization
• Create Teams
  • Everyone
    • Company-A
      • Team-A1
      • Team-A2
      • Team-A3
      • Team-A4
    • Company-B
      • Team-B1
      • Team-B2
      • Team-B3
      • Team-B4
    • Instructors
• Transfer handout repo from the previous organization
• Add labels as repository defaults in organization
  • effort: high
  • effort: low
  • effort: moderate
  • priority: critical
  • priority: high
  • priority: low
  • priority: normal
  • status: completed
  • status: duplicate
  • status: help wanted
  • status: in progress
  • status: invalid
  • status: pending
  • status: review needed
  • status: stalled
  • status: wontfix
  • type: bug
  • type: design
  • type: documentation
  • type: enhancement
  • type: integration
  • type: question
  • type: user story
• Create new repos for the project
  • AutomatedCar-A
  • AutomatedCar-B
• Add repositories to Teams and set permissions
  • Match AutomatedCar-A to Company-A with write permissions
  • Match AutomatedCar-B to Company-B with write permissions
  • Set admin persmissions to team Instructors
• Add milestones per sprint
  • repo A
  • repo B
• Add projects (kanban boards) from Automated kanban with review template
  • one project for every teams
  • repo A
  • repo B
• Add user stories
  • repo A
  • repo B
• Add link to team forums (discussion boards) and user stories in the project descriptions
• Integrate CI
  • GitHub Actions
  • repo A
  • repo B
• Integrate static code analyzer
  • CodeFactor.io
  • repo A
  • repo B
• Integrate code coverage tracker
  • CodeCov.io
  • repo A
  • repo B
• Enable stale bot to mark issues as staled if there is no activity for a while
  • repo A
  • repo B
• Update badges in the README
  • repo A
  • repo B
• Create a tag from the skeleton
  • git tag -a skeleton -m 'Tag skeleton'
  • and push it: git push origin --tags
  • repo A
  • repo B
• Create team branches
  • git checkout -b TeamA1
  • git push origin TeamA1
• Protect branches
  • repo A
  • repo B

• sprint1
  • hmi
  • model
  • powertrain
  • visualization
• sprint 2
  • ultrasonic
  • camera & colloision
    • state of motion simulation may be omitted this semester
  • npc
  • radar
• sprint 3
  • parking pilot
  • lka & tsr
  • acc
  • aeb
  • reverse radar