<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/">
  <channel>
    <title>DEV Community: Németh Mária</title>
    <description>The latest articles on DEV Community by Németh Mária (@nemethmaria).</description>
    <link>https://dev.to/nemethmaria</link>
    <image>
      <url>https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.us-east-2.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F4199305%2F2a0da43d-be1d-4cb3-b44a-2dd415a08812.jpg</url>
      <title>DEV Community: Németh Mária</title>
      <link>https://dev.to/nemethmaria</link>
    </image>
    <atom:link rel="self" type="application/rss+xml" href="https://dev.to/feed/nemethmaria"/>
    <language>en</language>
    <item>
      <title>What a Writer Notices When Learning Git</title>
      <dc:creator>Németh Mária</dc:creator>
      <pubDate>Sun, 25 Oct 2026 10:08:33 +0000</pubDate>
      <link>https://dev.to/nemethmaria/what-a-writer-notices-when-learning-git-38ed</link>
      <guid>https://dev.to/nemethmaria/what-a-writer-notices-when-learning-git-38ed</guid>
      <description>&lt;p&gt;I'm a writer who's learning to code, and Git was the first tool that really slowed me down. Commands like &lt;code&gt;rebase&lt;/code&gt; and &lt;code&gt;detached HEAD&lt;/code&gt; sounded alarming. Then something clicked: a lot of Git maps onto habits writers already have. Here are the comparisons that helped me, plus a few commands I now use every day.&lt;/p&gt;

&lt;h2&gt;
  
  
  Commits are like saved drafts with a note attached
&lt;/h2&gt;

&lt;p&gt;Writers keep versions: "draft 2", "draft 2 – shorter intro", "final_FINAL". Git does the same thing, minus the messy file names. Each commit is a snapshot, and the message explains what changed.&lt;/p&gt;

&lt;p&gt;The habit that helps most is making commits small and focused, the same way an editor prefers one clear change per round of edits.&lt;/p&gt;

&lt;h2&gt;
  
  
  Commit messages are tiny pieces of writing
&lt;/h2&gt;

&lt;p&gt;A good commit message works like a good headline: short, specific and active.&lt;br&gt;
&lt;/p&gt;

&lt;div class="highlight js-code-highlight"&gt;
&lt;pre class="highlight plaintext"&gt;&lt;code&gt;Fix broken link in installation guide

The old link pointed to a page that was removed.
Updated it to the current setup docs.
&lt;/code&gt;&lt;/pre&gt;

&lt;/div&gt;



&lt;p&gt;Some conventions I picked up:&lt;/p&gt;

&lt;ul&gt;
&lt;li&gt;Keep the first line short, around 50 characters.&lt;/li&gt;
&lt;li&gt;Use the imperative: "Add", "Fix", "Remove", not "Added" or "Fixing".&lt;/li&gt;
&lt;li&gt;Leave a blank line, then explain &lt;em&gt;why&lt;/em&gt; if it isn't obvious.&lt;/li&gt;
&lt;/ul&gt;

&lt;p&gt;"Update stuff" tells your future self nothing. "Fix typo in README title" tells them everything.&lt;/p&gt;

&lt;h2&gt;
  
  
  Branches are like trying a different version of a chapter
&lt;/h2&gt;

&lt;p&gt;When you want to rewrite a section without losing the original, you make a copy and experiment. A branch does exactly that:&lt;br&gt;
&lt;/p&gt;

&lt;div class="highlight js-code-highlight"&gt;
&lt;pre class="highlight shell"&gt;&lt;code&gt;git switch &lt;span class="nt"&gt;-c&lt;/span&gt; new-intro   &lt;span class="c"&gt;# start a new branch and move to it&lt;/span&gt;
&lt;span class="c"&gt;# ...edit files...&lt;/span&gt;
git add &lt;span class="nb"&gt;.&lt;/span&gt;
git commit &lt;span class="nt"&gt;-m&lt;/span&gt; &lt;span class="s2"&gt;"Rewrite introduction for beginners"&lt;/span&gt;
git switch main           &lt;span class="c"&gt;# go back to the original&lt;/span&gt;
&lt;/code&gt;&lt;/pre&gt;

&lt;/div&gt;



&lt;p&gt;If the experiment works, you merge it. If it doesn't, the original never changed.&lt;/p&gt;

&lt;h2&gt;
  
  
  &lt;code&gt;git diff&lt;/code&gt; is track changes
&lt;/h2&gt;

&lt;p&gt;If you've ever reviewed tracked changes in a document, &lt;code&gt;git diff&lt;/code&gt; is the same idea: removed lines in one colour, added lines in another. Running &lt;code&gt;git diff&lt;/code&gt; before every commit has become my version of proofreading. It's where stray debug lines and half-finished sentences get caught.&lt;/p&gt;

&lt;h2&gt;
  
  
  Commands I actually use most
&lt;/h2&gt;

&lt;p&gt;As a beginner, I found the full list of Git commands overwhelming. These cover most of my day:&lt;/p&gt;

&lt;ul&gt;
&lt;li&gt;
&lt;code&gt;git status&lt;/code&gt; shows what changed and what's staged&lt;/li&gt;
&lt;li&gt;
&lt;code&gt;git diff&lt;/code&gt; shows exactly what changed&lt;/li&gt;
&lt;li&gt;
&lt;code&gt;git add &amp;lt;file&amp;gt;&lt;/code&gt; stages a change&lt;/li&gt;
&lt;li&gt;
&lt;code&gt;git commit -m "message"&lt;/code&gt; saves a snapshot&lt;/li&gt;
&lt;li&gt;
&lt;code&gt;git log --oneline&lt;/code&gt; gives a short history&lt;/li&gt;
&lt;li&gt;
&lt;code&gt;git switch &amp;lt;branch&amp;gt;&lt;/code&gt; moves between versions&lt;/li&gt;
&lt;/ul&gt;

&lt;h2&gt;
  
  
  Still learning
&lt;/h2&gt;

&lt;p&gt;Merge conflicts still make me nervous, and I've only just started reading about &lt;code&gt;rebase&lt;/code&gt;. But thinking of Git as version control for writing, which is what it is, made it feel much less foreign.&lt;/p&gt;

&lt;p&gt;If you came to coding from a non-technical background, which comparison made Git click for you?&lt;/p&gt;

</description>
      <category>git</category>
      <category>beginners</category>
      <category>writing</category>
      <category>learning</category>
    </item>
    <item>
      <title>Writing a README People Actually Read: Notes From a Writer Learning to Code</title>
      <dc:creator>Németh Mária</dc:creator>
      <pubDate>Thu, 22 Oct 2026 10:10:20 +0000</pubDate>
      <link>https://dev.to/nemethmaria/writing-a-readme-people-actually-read-notes-from-a-writer-learning-to-code-5867</link>
      <guid>https://dev.to/nemethmaria/writing-a-readme-people-actually-read-notes-from-a-writer-learning-to-code-5867</guid>
      <description>&lt;p&gt;I'm learning to code. Along the way I've noticed something: the part of a project I understand fastest is usually the README. When a README is unclear, I often give up before I ever open the code.&lt;/p&gt;

&lt;p&gt;Writing is the part I'm comfortable with, so here are the habits I keep coming back to when I read (and try to write) READMEs.&lt;/p&gt;

&lt;h2&gt;
  
  
  Start with one sentence that says what it is
&lt;/h2&gt;

&lt;p&gt;The first line should answer "what is this, and who is it for?" Most visitors decide within seconds whether to keep reading. A sentence like "A command-line tool that renames photos by the date they were taken" does more work than three paragraphs of background.&lt;/p&gt;

&lt;h2&gt;
  
  
  Show it working before you explain it
&lt;/h2&gt;

&lt;p&gt;People want to see the result first. A short example near the top beats a long feature list:&lt;br&gt;
&lt;/p&gt;

&lt;div class="highlight js-code-highlight"&gt;
&lt;pre class="highlight markdown"&gt;&lt;code&gt;&lt;span class="gu"&gt;## Quick start&lt;/span&gt;&lt;span class="sb"&gt;

    npm install my-renamer-tool
    my-renamer-tool ./holiday-pics

&lt;/span&gt;Before: IMG_4021.jpg
After:  2026-08-14_10-32-05.jpg
&lt;/code&gt;&lt;/pre&gt;

&lt;/div&gt;



&lt;p&gt;Once readers can see what happens, the details that follow make sense.&lt;/p&gt;

&lt;h2&gt;
  
  
  Write install steps as if the reader knows nothing
&lt;/h2&gt;

&lt;p&gt;It's easy to skip steps that feel obvious to you. When I follow installation guides as a beginner, the missing piece is almost always something the author did without thinking: a required version, an environment variable, a folder you must be in. Numbered steps, one action each, are hard to get wrong.&lt;/p&gt;

&lt;h2&gt;
  
  
  Use headings as a map
&lt;/h2&gt;

&lt;p&gt;Many readers scan instead of reading top to bottom. A predictable set of headings helps them jump to what they need:&lt;/p&gt;

&lt;ul&gt;
&lt;li&gt;What it is&lt;/li&gt;
&lt;li&gt;Quick start&lt;/li&gt;
&lt;li&gt;Installation&lt;/li&gt;
&lt;li&gt;Usage&lt;/li&gt;
&lt;li&gt;Configuration&lt;/li&gt;
&lt;li&gt;Contributing&lt;/li&gt;
&lt;li&gt;License&lt;/li&gt;
&lt;/ul&gt;

&lt;p&gt;Not every project needs all of them, but sticking to familiar names means people don't have to guess.&lt;/p&gt;

&lt;h2&gt;
  
  
  Cut the words that don't help
&lt;/h2&gt;

&lt;p&gt;Editing habits carry over well from ordinary writing:&lt;/p&gt;

&lt;ul&gt;
&lt;li&gt;Replace "In order to" with "To".&lt;/li&gt;
&lt;li&gt;Delete "simply" and "just". If the step were simple, the reader wouldn't be in the docs.&lt;/li&gt;
&lt;li&gt;Keep paragraphs short. Three or four lines is plenty on a screen.&lt;/li&gt;
&lt;/ul&gt;

&lt;h2&gt;
  
  
  Keep it true
&lt;/h2&gt;

&lt;p&gt;A README that describes last year's version is worse than a short one. If a command changes, the README should change in the same commit. That's a coding habit I'm still building, but it's the one that seems to matter most.&lt;/p&gt;

&lt;h2&gt;
  
  
  What I'm still figuring out
&lt;/h2&gt;

&lt;p&gt;I haven't settled how much detail belongs in the README and how much should move to separate docs. My current rule of thumb: the README gets someone from "what is this?" to "it works on my machine". Anything beyond that gets its own page.&lt;/p&gt;

&lt;p&gt;If you have a README you think does this really well, I'd love to see it in the comments. Good examples are the best way I've found to learn.&lt;/p&gt;

</description>
      <category>writing</category>
      <category>documentation</category>
      <category>beginners</category>
      <category>opensource</category>
    </item>
  </channel>
</rss>
