From 53cc3f26ddb35d927e6ba7778df6180d60a94ca3 Mon Sep 17 00:00:00 2001 From: MultisampledNight Date: Fri, 19 Jan 2024 03:09:31 +0100 Subject: [PATCH] docs: bring back punctuation at end of points --- CONTRIBUTING.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6000ff..f81c296 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,35 +4,35 @@ Before we get started, thank you for thinking about doing so! ## Through an issue -- Be excellent to each other. Adhere to the [code of conduct] +- Be excellent to each other. Adhere to the [code of conduct]. - About the title: If you had 5 seconds to tell someone the essence of the issue, what would it be? ### Bugs -- Write out in detail which steps in which order are necessary to reproduce the bug -- Include environmental information as well, in specific +- Write out in detail which steps in which order are necessary to reproduce the bug. +- Include environmental information as well, in specific: - How did you install iOwO? - What version of iOwO are you running? - What operating system are you running? - In the case of a Linux distro, mention the specific distro and when you last update as well -- If the bug causes a crash, try to get a backtrace or in worse cases, a coredump + In the case of a Linux distro, mention the specific distro and when you last update as well. +- If the bug causes a crash, try to get a backtrace or in worse cases, a coredump. ### Feature requests - Be sure to include a motivation in which case your intended feature would be used - even if it seems obvious to you -- Estimate what would be needed to implement the feature + even if it seems obvious to you. +- Estimate what would be needed to implement the feature: - Is it an addition to the language itself? - Is it just a new command? - Does it ground-breakingly change how iOwO works? ## Through a PR -1. Clone the repo -2. Switch to a new appropiately named branch for what you want to do, using `git switch -c` -3. Implement your code changes with your favorite code editor -4. Try them with `cargo run` -5. If there are errors or warnings, go to step 3. Commit occasionally +1. Clone the repo. +2. Switch to a new appropiately named branch for what you want to do, using `git switch -c`. +3. Implement your code changes with your favorite code editor. +4. Try them with `cargo run`. +5. If there are errors or warnings, go to step 3. Commit occasionally. 6. Otherwise, - if you have an account at https://forge.katzen.cafe, 1. fork the repo @@ -80,9 +80,9 @@ If you want to contribute art or the like, do that in whatever **you** are most ### Major decisions -- All current maintainers have to agree **unanimously** -- Agreement must be based on [informed consent] - - In effect, a maintainer has to understand what they agree to +- All current maintainers have to agree **unanimously**. +- Agreement must be based on [informed consent]. + - In effect, a maintainer has to understand what they agree to. # Interacting with PRs @@ -90,8 +90,8 @@ Remember, be respectful. Entities invest their free time and motivation into making these changes, treat them appropiately. -- Since in iOwO, we mostly work based on forks, [git's remotes] work fairly good -- Replace things in pointy brackets (`<>`) respectively (and remove the pointy brackets) +- Since in iOwO, we mostly work based on forks, [git's remotes] work fairly good. +- Replace things in pointy brackets (`<>`) respectively (and remove the pointy brackets). ## Initial steps for a new contributor or new local checkout @@ -102,8 +102,8 @@ git remote update ## After setting up the remote -- You can repeat this step anytime you want to switch branches or update your local checkout -- The PR branch is visible just below the PR title on Forgejo, after the colon (`:`) +- You can repeat this step anytime you want to switch branches or update your local checkout. +- The PR branch is visible just below the PR title on Forgejo, after the colon (`:`). ```sh git switch