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

2024-what-makes-code-good #123

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

carinaschrenk
Copy link
Collaborator

@carinaschrenk carinaschrenk commented Nov 19, 2024

Article of Round 2

carinaschrenk and others added 2 commits November 19, 2024 21:48
added article about best practices in coding (article of round 2)
@tri2820 tri2820 changed the title Article 'What makes code good?' 2024-what-makes-code-good Nov 21, 2024
@carinaschrenk
Copy link
Collaborator Author

Internal Feedback Round 2A 21.11

Thoughts

  • The second paragraph is good
  • Fluffy introduction -> could be more to the core
  • Good information to know

Ideas

  • The first paragraph could be sharper
    • -> code is not only written for machines but for humans -> revisability

@belle903
Copy link
Collaborator

External feedback:

Part of participants that are computer science students/graduates: 45 %
Part of participants that would read the booklet if it was not for this survey: 67 %

Clarity of the article:

  • Very clear: 39 %
  • Clear: 28 %
  • Not clear: 33 %

Technical vs. Non-technical:

  • Good balance between technical depth and readability: 61 %
  • The article was too technical: 39 %

Engagement:

  • I stayed engaged throughout: 56 %
  • I lost interest midway: 44 %

Structure of the article:

  • The structure is clear and easy to follow: 61 %
  • The structure was confusing: 39 %

Part of participants that understand the purpose of the article: 72 %

Part of participants that think the drawing helps to understand the meaning of the article: 56 %

Factual errors/inaccuracies or additional comments: -

@ParthS007
Copy link
Collaborator

What is good code?

Code is more than just instructions for machines; it’s a shared language for humans. Good code allows collaboration by ensuring that every person who interacts with it—the original author, a colleague, or even someone years later—can understand and contribute effectively.

Good code is clear, well-documented and embraces consistency.

Good code is not just a technical artefact; it’s a conversation. It bridges gaps, aligns efforts, and empowers teams to build software efficiently and joyfully.

@carinaschrenk carinaschrenk added 2024: Status - Included - Booklet The article made it into the final selection. But might still need minor changes before merging and removed 2024: revised labels Dec 19, 2024
Copy link

cloudflare-workers-and-pages bot commented Dec 23, 2024

Deploying tilics with  Cloudflare Pages  Cloudflare Pages

Latest commit: fcc1c82
Status:🚫  Build failed.

View logs

@carinaschrenk carinaschrenk added the 2024: revised Did the author create a new version based on the creative feedback? label Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2024: Category - Practical 2024: Difficulty - Easy 2024: Length - Medium 2024: revised Did the author create a new version based on the creative feedback? 2024: round 2 articles of round 2 2024: Status - Included - Booklet The article made it into the final selection. But might still need minor changes before merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants