Skip to content

Commit

Permalink
fix headings
Browse files Browse the repository at this point in the history
  • Loading branch information
EndangeredMassa committed Sep 30, 2023
1 parent f81e3b6 commit 109373c
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 33 deletions.
6 changes: 2 additions & 4 deletions app/components/article-header.gjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@ import { LinkTo } from '@ember/routing';

<template>
<div class="blog-item">
<div class="post-link">
<h1>
{{@article.title}}
</div>
<p class="meta"><i>{{{@article.description}}}</i></p>
</h1>
<p class="meta">{{@article.date}}</p>
</div>
</template>

4 changes: 2 additions & 2 deletions app/templates/article/conventional-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,12 @@ All comments are also non-blocking unless otherwise specified.
>
> It looks like the code and test are accidentally checking that the file was found, but I think here we expect the file to not be found.
# Takeaways
## Takeaways

This structure makes it clear to others what needs to be done. It's also a good forcing function for the author to consider the feedback they provide more carefully.

The best part is that readers don't have to know about the structure to understand feedback written in this style.

# Related Topics
## Related Topics

See [Detangling the Code Review](./detangling-the-code-review) for details about different kinds of feedback.
8 changes: 4 additions & 4 deletions app/templates/article/detangling-the-code-review.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<ArticleHeader @article={{this.model}} />

# Responsibility
## Responsibility

As a team member, you have the following responsibilities to your teammates regard code reviews:

Expand All @@ -18,7 +18,7 @@ As a code change author requesting review, you have the following responsibiliti
- write detailed descriptions of why your changes were made in review requests
- respond quickly to feedback

# Understanding Code Review Comments
## Understanding Code Review Comments

**Your goal is to approve the code change if at all possible.** This builds momentum, shows progress, and even in cases where the author needs to make a change, allows their original contribution to be impactful.

Expand Down Expand Up @@ -92,7 +92,7 @@ This structure gives you a shared set of language and expectations to make code

However, there is room for flexibility. When the site is down, feel free to toss these ideas out the window. When you have a good reason to deviate from this, just explain way.

# Takeaways
## Takeaways

This model gives you the tools to consume and express code review comments more effectively.

Expand All @@ -104,7 +104,7 @@ The type of comment (Question, Preference, Convention, Suggestion, or Requiremen
- Convention: soft-blocking
- Requirement: blocking

# Related Topics
## Related Topics

However feedback on code changes is provided, they should be communicated with compassion. You should consider how your comments will be received based on team context and experience level of the author. Dr. McKayla goes into much more detail on [compassionate code review](https://www.michaelagreiler.com/respectful-constructive-code-review-feedback/).

Expand Down
10 changes: 5 additions & 5 deletions app/templates/article/detangling-the-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The core argument follows. The most important parts are bold.

---

# **Conflicting Roles and Incentives**
## **Conflicting Roles and Incentives**

The term Manager means a lot of different things to different companies. It can include Project Manager, Product Manager, Technical Lead, Team Lead, Mentor, Coach, Supervisor, as well as Individual Contributor. Most often, in my experience, a manager is responsible for at least these roles: Supervisor, Mentor, and Team Lead.

Expand All @@ -37,7 +37,7 @@ For each type of manager, they play their secondary roles to a lesser degree, so

The Mentor role is most often absent and most often needed. It also exposes the strongest conflict between these three roles. Mentor directly conflicts with Supervisor: When you feel like you are not doing a good job, you should be able to talk to a Mentor about it, but a Supervisor may judge you for it, affecting your opportunities and compensation.

# **Ideal Solution: Separate Roles for Separate People**
## **Ideal Solution: Separate Roles for Separate People**

I think the clearest solution is to split the roles, but that option isn't possible for every organization. Either your company is too small or too rigid in organizational structure. If you can't split up the roles, see the next section on a Pragmatic Solution. If you can split the roles, read on!

Expand All @@ -53,7 +53,7 @@ For those playing multiple roles, expectations should be set appropriately. It's

This works! The role conflict melts away, leading to a happier, more productive department.

# **Pragmatic Solution: Strategies for Playing Conflicting Roles**
## **Pragmatic Solution: Strategies for Playing Conflicting Roles**

Companies aren't always large or flexible enough to split up the Manager's roles into multiple people.

Expand All @@ -65,7 +65,7 @@ The core strategy to resolve the internal conflict is to try to only wear one ro

**Stay Self-aware:** In other ad-hoc interactions, you may be playing any of these roles. Recognize that your suggestions can come across as commands. Be explicit with teammates about which roles you are playing when.

## Performance Assessment **of Your Many Hats**
### Performance Assessment **of Your Many Hats**

If your company doesn't have clear expectations per role, you should write them out for yourself.

Expand All @@ -83,7 +83,7 @@ Then, ask each Team Member to review your performance of each role they interact

Performance Review itself is a topic for another day. The import part here is that each role is reviewed separately.

# Continued Learning
## Continued Learning

For me:

Expand Down
10 changes: 3 additions & 7 deletions app/templates/article/detangling-the-standup.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Note that the value of each process will vary by team composition and project ma
- More vs. less experienced
- Kanban vs. Sprint vs. Project vs. Waterfall styles

# Pragmatic Approach
## Pragmatic Approach

Figure out what kind of standup you have will help you understand its purpose. That will help you accept the value it provides, even if it’s not for you.

Expand All @@ -38,8 +38,6 @@ These contributions are most useful to the team lead and/or stakeholders to unde

> Yesterday I was working on the “Sign In With Google” story, but hit a weird issue with the integration. I spent a few hours debugging it. I should finish it this morning. Today, I’ll finish that story and pick up the next one.


**Context Sharing “Standups”**

Individual contributions to these meetings focus on what was done, how, and/or why. They include specifics.
Expand All @@ -50,7 +48,6 @@ These contributions are generally more useful to the individual contributors on
>
> In my debugging, I built up a wrapper component that smooths over the confusing parts and more clearly validates inputs based on our needs. Make sure you use it in our other apps if you need to implement Google sign in.

**Community Building “Standups”**

Individual contributions to these meetings pay lip service to the premise of a “Standup”, but spend a non-trivial amount of time on socializing.
Expand All @@ -69,8 +66,7 @@ These contributions are generally more useful to the individual contributors on

> Yesterday I was working on the “Sign In With Google” story, but hit a weird issue with the integration. I spent a few hours debugging it. I’m still not sure what the problem is. Can someone pair with me on this today, ideally this morning?

# Ideal Approach
## Ideal Approach

The best approach to tackling the Standup confusion is to make a list of these kinds of problems, decide if your team has any of those problems (solved for, or not), then ensure you have good solutions for the problems your team has.

Expand Down Expand Up @@ -125,6 +121,6 @@ Almost all of these solutions reduce the number of meetings team members have. T
- **Virtual Breaks:** Set up specific times (like Tuesdays/Thursdays from 10am - 12pm) where people can join a virtual break room call. People can hang out, work, and/or chat in that space.
- *Why It’s Better:* Especially for remote teams, it can be easy to feel disconnected from your team. Having time specifically set aside for socializing can make it happen more smoothly.

# Take Away
## Take Away

Standups are not bad, just often misapplied. Understand the problems you need solved and what the best solutions might be. If that’s a standup-style meeting, then go for it. I just don’t think it should be the default.
8 changes: 4 additions & 4 deletions app/templates/article/how-to-start-linting-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
I have gone through the process of adding linting to existing, large projects a couple of times. I've learned some lessons about how to approach this so that it's not disruptive to the team doing other work. Follow these steps to get robust linting into your project without pulling team velocity to a halt!


# What's So Great About Linting?
## What's So Great About Linting?

The really great benefits to code linting are that it:

Expand All @@ -17,7 +17,7 @@ Consistency of code removes the need to make decisions (individually and as a te
It can also be valuable to adopt coding styles shared by a larger community. Your language, framework, or tools' communities will have their own conventions. Aligning with those can help alleviate friction when a developer switches context between internal and external code as well as when a developer changes jobs internally or externally.


# How Do I Get Started?
## How Do I Get Started?

### Collect Existing Conventions

Expand Down Expand Up @@ -49,12 +49,12 @@ Submit the changes for review. Team members can disagree and have a conversation
Repeat this step until all rules are back on!


# The Result
## The Result

We now have a process for incremental maintenance work that we can do in small chunks to improve the state of the code. As long as your team has the appropriate slack time dedicated to maintenance, you'll get through all of this work in no time!


# I Want More!
## I Want More!

There are a lot of great linters out there. Here's a list to get you started!

Expand Down
14 changes: 7 additions & 7 deletions app/templates/article/theme-pact.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ I'll spare you my long (and boring) history with struggling to answer these ques

I've tried the first approach for many years. It's time to try the second.

# Theme Pact Framework
## Theme Pact Framework

Pulling from several sources, my framework for goal setting includes:

Expand All @@ -28,7 +28,7 @@ I like this model because you control the direction and personal outputs. Succes

By leveraging the power of direction, defaults, and habits, this framework makes success happen as a matter of course. Well, that's the theory.

# What is a Theme?
## What is a Theme?

*This concept comes from the [Theme System](https://www.thethemesystem.com/), developed by [Myke Hurley](https://twitter.com/imyke) and [CGP Grey](https://twitter.com/cgpgrey/) through [Cortex](https://www.relay.fm/cortex).*

Expand All @@ -46,7 +46,7 @@ For my purposes, I decided a theme has to be:

**Infallible:** A theme is infallible. You cannot fail. It's a direction, not a destination.

# What is a PACT Goal?
## What is a PACT Goal?

*This concept comes from [SMART goals are not so smart: make a PACT instead](https://nesslabs.com/smart-goals-pact)* by [Anne-Laure Le Cunff](https://twitter.com/neuranne) through [Ness Labs](https://twitter.com/ness_labs).

Expand All @@ -66,7 +66,7 @@ I extend this further to include:

**Habitual:** My PACT Goals are habitual. They either rely on existing habits to trigger new behavior or define new habits I'll need to develop in order to accomplish the goal.

# What is a Habit?
## What is a Habit?

*This concept comes from [Atomic Habits](https://jamesclear.com/atomic-habits)* by [James Clear](https://jamesclear.com/).

Expand All @@ -85,7 +85,7 @@ Craving and Reward are two sides of the same coin. You need to make the habit re

I focus mostly on setting new good habits here, but James makes it clear that you can use a similar system to break bad habits.

# Setting a Theme Pact
## Setting a Theme Pact

Steps:

Expand All @@ -96,13 +96,13 @@ Steps:
5. If any of your PACT Goals needs support from a new habit: define new habits
6. Track your progress

# Outcomes
## Outcomes

My first stab at this was too much all at once. I did form some useful habits around my theme, but I couldn’t keep up with everything I tried to do.

I (re-)discovered that smaller iterations are better. If you are going from zero to Theme Pact, I suggest iteratively adding pieces until you are comfortable with a given piece. To start, define a theme OR work on forming one good habit OR work on breaking one bad habit.

# Resources
## Resources

If you want to learn more about these topics, I recommend the following.

Expand Down

0 comments on commit 109373c

Please sign in to comment.