Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Guidance for using & configuring the default CLI text editor #3

Open
psokolhessner opened this issue Apr 20, 2020 · 1 comment
Open

Guidance for using & configuring the default CLI text editor #3

psokolhessner opened this issue Apr 20, 2020 · 1 comment
Assignees
@aridyckovsky
Labels
enhancement New feature or request

Comments

@psokolhessner
Copy link
Member

Is your feature request related to a problem? Please describe.
The default text editor (vi) for git commit requests is a little opaque/frustrating to use esp. for people who don't use CLI-based text editors very often.

Describe the solution you'd like

  • A brief description of how to use vi, as well as a reference to this page, which I personally found helpful: https://www.howtogeek.com/102468/a-beginners-guide-to-editing-text-files-with-vi/
  • Guide on how to configure the default text editor to be something more accessible (unsure what are good options here, but I've found pico to be relatively easy/straightforward).
  • List of a few recommended CLI text editors w/ a single sentence describing what they're like to work with (i.e. strengths/weaknesses, focused on ease of use).

Additional context
It's possible others' default CLI text editor is not vi? In which case the more general solution is preferred here (description of how to configure a personal choice of default CLI text editor; and a listing of some particularly good options)
@psokolhessner psokolhessner added the enhancement New feature or request label Apr 20, 2020
@aridyckovsky aridyckovsky self-assigned this Apr 20, 2020
aridyckovsky added a commit that referenced this issue Apr 20, 2020
@aridyckovsky
Add section for Text Editor guide
d9cea02 
Reason:
- Need guidance for using CLI text editors
- Config defaults for git text editors

Changes made:
- Add section on text editors
- Add subsection on Vim and Sublime
- Explain Vim

Notes:
- Feature request from @pskolhessner
- Issue #3
aridyckovsky added a commit that referenced this issue Apr 20, 2020
@aridyckovsky
Add links to Vim tutorials and references
a110c82 
Reason:
- Lacking accessible links to learn more

Changes made:
- Mostly links added, but some wording changed

Notes:
- Issue #3
aridyckovsky added a commit that referenced this issue Apr 20, 2020
@aridyckovsky
Feature: instructions for default git text editor
cfbcb7b 
Reason:
- Add config steps for default text editor
  for git commit messages

Changes made:
- Enforce h4 sections for git config globals
- Add instructions

Notes:
- Issue #3
aridyckovsky added a commit that referenced this issue Apr 20, 2020
@aridyckovsky
Include section for Atom
dfe7b01 
Reason:
- Sublime and Atom are both great tools

Changes made:
- Add section for Atom
- Add links to Sublime and Atom

Notes:
- Issue #3
aridyckovsky added a commit that referenced this issue Apr 20, 2020
@aridyckovsky
BUGFIX: faulty links to Sublime and Atom
013df70 
Reason:
- Switched markup notation caused bad rendering

Changes made:
- Switched [] and ()

Notes:
- Issue #3
@aridyckovsky
Copy link
Member

Put together a section on vim, plus a quick couple of lines on Atom and Sublime. More importantly, in the "Git: Install & Setup" section, global configurations include setting a default text editor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aridyckovsky aridyckovsky

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@aridyckovsky @psokolhessner