Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

weeklyReport2.md review #14

Open
7 of 11 tasks
MaximeTAlgosup opened this issue Jan 20, 2025 · 0 comments
Open
7 of 11 tasks

weeklyReport2.md review #14

MaximeTAlgosup opened this issue Jan 20, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation low Low priority level management Management related

Comments

@MaximeTAlgosup
Copy link
Collaborator

MaximeTAlgosup commented Jan 20, 2025

Background Information

Errors and Improvements would be displayed this way:

Line number: error spotted -> potential solution

convention:

  • what is already written
  • what's wrong
  • potential solution

Improvement(s)

Naming convention

  • Conventions are respected

Spelling errors

  • L.17: We needed to include libraries to our program, ... -> We needed to include libraries to in our program, ...
  • L.17: ... some modifications on those libraries. -> ... some modifications on to those libraries.
  • L.27: ... But still the team members ... -> ... But still**,** the team members ... add a coma after "But still"

links misbehavior

  • No links

tables malfunction

  • No tables

Coherency issues

  • Stay consistent. Some of your lines have a ending point and some other not. I'll advise you to put one after those lines:
    • L.10: We have a reassuring progress on the program -> We have a reassuring progress on the program**.**
    • L.15: Some team members were absent, which slowed the progress of some documents -> Some team members were absent, which slowed the progress of some documents**.**

Other Suggestion(s)

  • You can put some more accomplishments such has the documents completion for example.
  • Try to fill your parts with more than one bullet.
@MaximeTAlgosup MaximeTAlgosup added documentation Improvements or additions to documentation low Low priority level management Management related labels Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation low Low priority level management Management related
Projects
None yet
Development

No branches or pull requests

2 participants