carpentries-incubator / carpentries-incubator/swc_github_flow

Unclear on how to edit files via CLI

Open
#25 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
12
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Under the CLI section, 'Making your edits' ...

point 5)
I think it would make it easier for novices to follow if you specify how to edit the files (e.g. "You can now open the file in a text editor and edit as needed"). I think it would also help to clarify if you run "git add file.md" before or after opening and editing the respective file.
I'm new to git CLI and these are things that I found a bit confusing.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.