Skip to content

Software Engineering Practices for Scrum Updates #1#291

Merged
MrHinsh merged 1 commit into
mainfrom
updates-for-Software-Engineering-Practices-for-Scrum
Jan 21, 2026
Merged

Software Engineering Practices for Scrum Updates #1#291
MrHinsh merged 1 commit into
mainfrom
updates-for-Software-Engineering-Practices-for-Scrum

Conversation

@MrHinsh
Copy link
Copy Markdown
Collaborator

@MrHinsh MrHinsh commented Jan 20, 2026

This pull request updates the site/content/software-engineering-practices/2026.1/index.md file to improve the clarity and consistency of references throughout the document. The main focus is converting inline and URL-based references to use standardized markdown footnote syntax, ensuring a more professional and maintainable documentation style. Minor text and formatting improvements were also made for consistency and readability.

Key changes include:

Reference and Citation Improvements:

  • Converted all in-text and URL-based citations to markdown footnote syntax (e.g., [2] to [^2]), ensuring a consistent referencing approach throughout the document. [1] [2] [3] [4] [5] [6] [7]

Formatting and Text Consistency:

  • Standardized list item punctuation and formatting, such as replacing periods with dashes and ensuring consistent use of bold and italics in principle and practice lists. [1] [2]
  • Corrected minor typographical issues, such as removing unnecessary backslashes and aligning quotation marks and exclamation points. [1] [2]

Content Clarification:

  • Reworded or clarified references to books, videos, and external resources to use footnotes, improving document readability and maintainability. [1] [2]

These changes help make the document more professional, easier to navigate, and maintain, especially as references grow or change over time.


This change is Reviewable

@github-actions
Copy link
Copy Markdown

Azure Static Web Apps: Your stage site is ready! Visit it here: https://agreeable-island-0c966e810-291.centralus.6.azurestaticapps.net

@MrHinsh MrHinsh marked this pull request as ready for review January 21, 2026 15:30
Copilot AI review requested due to automatic review settings January 21, 2026 15:30
@MrHinsh MrHinsh merged commit fdc95bf into main Jan 21, 2026
6 checks passed
@MrHinsh MrHinsh deleted the updates-for-Software-Engineering-Practices-for-Scrum branch January 21, 2026 15:30
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request standardizes the reference formatting in the Software Engineering Practices guide by converting inline and URL-based citations to markdown footnote syntax, aligning with the academic reference format established in other guides like the Psychological Safety guide. The changes improve documentation maintainability and professional presentation.

Changes:

  • Converted all in-text citations from [N] to [^N] format and inline URLs to footnote references
  • Standardized list item punctuation by replacing colons/periods with dashes for consistency
  • Updated the References section with proper academic formatting including italicized titles, proper punctuation, and access dates


[^38]: Farley, D. (2022) _How to Design Better Software_ [Video]. YouTube. Available at: [https://youtu.be/8GONv6jJsG0](https://youtu.be/8GONv6jJsG0) (Accessed: 22 November 2025).

[^39]: Farley, D. (2022) _What Software Architecture Should Look Like?_ [Video]. YouTube. Available at: [https://youtu.be/ElMnHDSFaCw](https://youtu.be/ElMnHDSFaCw) (Accessed: 22 November 2025).
Copy link

Copilot AI Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

References [^36] (line 539) and [^39] (line 545) are duplicate entries pointing to the same video. The reference at line 370 using [^39] should either reuse [^36] or point to a different resource if a distinct citation was intended.

Suggested change
[^39]: Farley, D. (2022) _What Software Architecture Should Look Like?_ [Video]. YouTube. Available at: [https://youtu.be/ElMnHDSFaCw](https://youtu.be/ElMnHDSFaCw) (Accessed: 22 November 2025).
[^39]: Farley, D. (2022) _What Software Architecture Should Look Like?_ [Video]. YouTube. See reference [^36] for full bibliographic details.

Copilot uses AI. Check for mistakes.
[^6]: Wikipedia (2023) 'Coupling (computer programming)', _Wikipedia_. Available at: [https://en.wikipedia.org/wiki/Coupling_(computer_programming)](https://en.wikipedia.org/wiki/Coupling_(computer_programming)) (Accessed: 23 November 2025).

[7] Harvey, N. (2025) ‘DORA’s software delivery metrics: the four keys’. DORA. Available at: <https://dora.dev/guides/dora-metrics-four-keys/> (Accessed: 22 November 2025).
[^7]: Feynman, R. (no date) _The Pleasure of Finding Things Out_. Quoted in various works.
Copy link

Copilot AI Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reference for the Feynman quote lacks proper academic citation. "Quoted in various works" is too vague. Following the project's reference formatting standards, this should cite the specific source where this quote appears, such as "The Pleasure of Finding Things Out: The Best Short Works of Richard P. Feynman" (1999) or another specific publication with proper publication details including publisher and page numbers if available.

Suggested change
[^7]: Feynman, R. (no date) _The Pleasure of Finding Things Out_. Quoted in various works.
[^7]: Feynman, R.P. (1999) *The pleasure of finding things out: The best short works of Richard P. Feynman*. Cambridge, MA: Perseus Books.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants