Skip to content

Commit

Permalink
Renamed Unit Testing, Estimation
Browse files Browse the repository at this point in the history
  • Loading branch information
robmoffat committed Jun 15, 2024
1 parent 06c5935 commit 2c4f54d
Show file tree
Hide file tree
Showing 9 changed files with 73 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/methods/DevOps.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ method:
reason: "Security as Code and Automated Security Testing integrate security practices into the DevOps pipeline."
use:
- Automated Security Testing
- tag: Unit Testing
- tag: Automated Testing
reason: "Automated Testing and Test Driven Development (TDD) validate code changes to ensure they work as expected."
use:
- Automated Testing
Expand Down
4 changes: 2 additions & 2 deletions docs/methods/Lean.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ method:
reason: "Lean uses set-based concurrent engineering to explore multiple design options and narrow down to the best solution."
use:
- Set-Based Concurrent Engineering
- tag: Estimation
- tag: Estimating
reason: "Lean focuses on working in small, manageable batches to reduce cycle time and increase feedback, aiding in more accurate estimation."
use:
- Small Batch Sizes
Expand Down Expand Up @@ -83,7 +83,7 @@ method:
reason: "Lean emphasizes respecting people and engaging stakeholders."
use:
- Respect People
- tag: Unit Testing
- tag: Automated Testing
reason: "Lean ensures that quality is built into the product from the beginning."
use:
- Build Quality In
Expand Down
6 changes: 4 additions & 2 deletions docs/methods/Scrum.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ method:
reason: "Scrum includes sprint reviews which act as demos for stakeholders."
- tag: Documentation
reason: "Documentation is produced, but Scrum values working software over comprehensive documentation."
- tag: Estimation
- tag: Estimating
reason: "Estimation is performed during sprint planning using techniques like story points."
use:
- Planning Poker
Expand Down Expand Up @@ -69,8 +69,10 @@ method:
reason: "Scrum includes regular reviews in the form of sprint reviews and retrospectives."
- tag: Release Delivery
reason: "Scrum focuses on frequent releases, with potentially shippable increments delivered at the end of each sprint."
- tag: Unit Testing
- tag: Automated Testing
reason: "Unit testing is part of the Definition of Done in Scrum."
use:
- Unit Testing
- tag: Code Reviews
reason: "Code reviews can be part of the development practices within Scrum."
- tag: Stakeholder Management
Expand Down
6 changes: 3 additions & 3 deletions docs/methods/XP.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ method:
reason: "XP encourages two developers working together at one workstation, which improves code quality and facilitates knowledge sharing."
use:
- "Collective Code Ownership"
- tag: Unit Testing
- tag: Automated Testing
reason: "XP emphasizes writing tests before coding, ensuring that the software meets its requirements from the start."
use:
- Test Driven Development (TDD)
- Automated Testing
- Unit Testing
- tag: Integration Testing
reason: "XP practices include integrating code into a shared repository frequently, which helps in identifying integration issues early."
use:
Expand Down Expand Up @@ -49,7 +49,7 @@ method:
- User Stories
- tag: Debugging
reason: "Debugging is an essential part of the development process in XP."
- tag: Estimation
- tag: Estimating
reason: "XP uses practices like planning games to estimate the time and resources needed for tasks."
use:
- Planning Game
Expand Down
5 changes: 3 additions & 2 deletions docs/practices/Planning-And-Management/Issue-Management.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@
title: Issue Management
description: Logging support issues and tracking their resolution.
tags:
- Issue Logging
- Planning-Management
featured:
class: c
element: '<action>Issue Logging</action>'
element: '<action>Issue Management</action>'
practice:
aka:
- "Issue Tracking"
- "Ticket Logging"
- "Bug Tracking"
- "Backlog"
- "Risk Management"
mitigates:
- tag: Implementation Risk
reason: "Tracks and manages defects and issues, ensuring they are resolved."
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Unit Testing
title: Automated Testing
description: Writing and running tests for individual units or components of the software.
tags:
- Testing-Quality-Assurance
Expand All @@ -10,7 +10,6 @@ practice:
aka:
- "Component Testing"
- "Module Testing"
- "Test-Driven Development (TDD)"
mitigates:
- tag: Implementation Risk
reason: "Ensures that individual components work correctly."
Expand Down
8 changes: 6 additions & 2 deletions docs/practices/todo.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
1. Risk Hierarchies
- Need to link risk hierarchies. DONE
- Create a special top-of hierarchy page, which lists out the other risks in the hierarchy
- Title of page should be a tag automatically.
- Create a special top-of hierarchy page, which lists out the other risks in the hierarchy DONE
- Title of page should be a tag automatically. DONE

2. Check that the risks are balanced. which risks don't we use? Why?

Expand Down Expand Up @@ -29,4 +29,8 @@ FIX LINKS AND RISK DIAGRAMS
- books for each method.


AFTER MERGE

Consider_payoff should use "Bets" tag.


23 changes: 22 additions & 1 deletion src/theme/DocTagDocListPage/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,27 @@ function DocItem({ doc }) {
);
}

function DocItemImage({ doc }) {
const pl = doc.permalink
const stripped = pl.endsWith('/') ? pl+"index" : pl
const imageLink = "/img/generated/single/" + stripped + ".png"

return (

<article className={styles.docItem}>
<div className={styles.columns}>
<div className={styles.left}>
<img src={imageLink} className={styles.articleImage} />
</div>
<div className={styles.right}>
<Link key={doc.permalink} to={doc.permalink}><h3>{doc.title}</h3></Link>
<p className={styles.description}>{doc.description}</p>
</div>
</div>
</article>
);
}

function categoryFromPermalink(pl) {
return pl.substr(1).replace(new RegExp("/$"), "").replaceAll("/", " > ")
}
Expand Down Expand Up @@ -116,7 +137,7 @@ export default function DocTagDocListPage({ tag }) {
{md ?
<section key="maindoc" className={`margin-vert--lg ${styles.main}`} style={{textTransform: "capitalize"}}>
<h2>Main Result</h2>
<DocItem id={-1} doc={md} />
<DocItemImage id={-1} doc={md} />
</section> : ""
}

Expand Down
32 changes: 31 additions & 1 deletion src/theme/DocTagDocListPage/styles.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,37 @@
}

.main article {
border: 2px solid lightgrey;
border: 1px solid lightgrey;
border-radius: 1rem;
padding: 2rem;
}

.columns {
display: flex;
gap: 1rem;
align-items: center;
}

.left {
flex-basis: 10rem;
flex-shrink: .5;
flex-grow: 0;
padding: 0;
margin: 0;
}

.left img {
padding: 0;
display: block;
}

.description {
color: grey;
}

.right {
flex-basis: 15rem;
flex-grow: .7;
flex-shrink: .5;
padding: 1rem;
}

0 comments on commit 2c4f54d

Please sign in to comment.