Skip to content

update git articles#88

Merged
spellingcat merged 2 commits intomainfrom
2025-stage-1-edits-fr
Aug 18, 2025
Merged

update git articles#88
spellingcat merged 2 commits intomainfrom
2025-stage-1-edits-fr

Conversation

@spellingcat
Copy link
Copy Markdown
Member

No description provided.

@spellingcat spellingcat requested a review from kevinclark July 31, 2025 23:31
@spellingcat spellingcat linked an issue Jul 31, 2025 that may be closed by this pull request
Copy link
Copy Markdown
Contributor

@kevinclark kevinclark left a comment

Choose a reason for hiding this comment

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

Couple of suggestions but nothing blocking.


While many modern cloud applications, like google docs, have some form of auto-save to the cloud, we don't necessarily want a single auto-updating version of our code.
Instead we use a tool called Git to manage different versions of our files and save them to Github, which lets us share the codebase between computers.
Because code can break very quickly in ways that might not be immediately obvious, it's good to be able to take a "snapshot" of the code at a point where it worked.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is the most Athena way I could imagine this being described.

Not a problem, but you might consider that making changes can introduce breakage. This sounds like code just breaks for no reason.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

🤣 noted lol

Similar to the Slack lists we use for other projects on the team, the robot software subteam uses Github Projects to manage projects and delegate tasks.
You can access the Project for each repository in its own tab at the top, and add tasks organized by the status columns.

Tasks that are explicitly about a specific PR should be converted to an issue and linked to that PR.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You might want to link to wherever they document issues integration with commit messages. The announcement is here but I can't find the doc.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

oh that's cool, i didn't know you could do that

Copy link
Copy Markdown
Member Author

@spellingcat spellingcat Aug 18, 2025

Choose a reason for hiding this comment

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

i do think i slightly prefer having the name of the feature/fix as the commit message since we've typically squashed prs into a single commit, but i'm also going to be stricter about using the GH project and linking stuff that way so it should hopefully be unambiguous

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Oh you don't have to choose - you should definitely do both. For example, you can say:

Use beambreak to control position of note. [Fixes #10]

Actual documentation here.

@spellingcat spellingcat merged commit 36d8b30 into main Aug 18, 2025
1 check passed
@spellingcat spellingcat deleted the 2025-stage-1-edits-fr branch August 18, 2025 06:07
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.

[2025] Stage 1 updates

2 participants