schrottkatze/iowo
0
0
Fork 0
mirror of https://forge.katzen.cafe/katzen-cafe/iowo.git synced 2024-11-24 14:28:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: bring back punctuation at end of points

Browse source
This commit is contained in:
MultisampledNight 2024-01-19 03:09:31 +01:00
parent ec3d1310bf
commit 53cc3f26dd
No known key found for this signature in database
GPG key ID: C81EF9B053977241
1 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
CONTRIBUTING.md
View file

@ -4,35 +4,35 @@ Before we get started, thank you for thinking about doing so!
## Through an issue ## 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? - About the title: If you had 5 seconds to tell someone the essence of the issue, what would it be?
### Bugs ### Bugs
- Write out in detail which steps in which order are necessary to reproduce the bug - Write out in detail which steps in which order are necessary to reproduce the bug.
- Include environmental information as well, in specific - Include environmental information as well, in specific:
- How did you install iOwO? - How did you install iOwO?
- What version of iOwO are you running? - What version of iOwO are you running?
- What operating system 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 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 - If the bug causes a crash, try to get a backtrace or in worse cases, a coredump.
### Feature requests ### Feature requests
- Be sure to include a motivation in which case your intended feature would be used - Be sure to include a motivation in which case your intended feature would be used
even if it seems obvious to you even if it seems obvious to you.
- Estimate what would be needed to implement the feature - Estimate what would be needed to implement the feature:
- Is it an addition to the language itself? - Is it an addition to the language itself?
- Is it just a new command? - Is it just a new command?
- Does it ground-breakingly change how iOwO works? - Does it ground-breakingly change how iOwO works?
## Through a PR ## Through a PR
1. Clone the repo 1. Clone the repo.
2. Switch to a new appropiately named branch for what you want to do, using `git switch -c` 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 3. Implement your code changes with your favorite code editor.
4. Try them with `cargo run` 4. Try them with `cargo run`.
5. If there are errors or warnings, go to step 3. Commit occasionally 5. If there are errors or warnings, go to step 3. Commit occasionally.
6. Otherwise, 6. Otherwise,
- if you have an account at https://forge.katzen.cafe, - if you have an account at https://forge.katzen.cafe,
1. fork the repo 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 ### Major decisions
- All current maintainers have to agree **unanimously** - All current maintainers have to agree **unanimously**.
- Agreement must be based on [informed consent] - Agreement must be based on [informed consent].
- In effect, a maintainer has to understand what they agree to - In effect, a maintainer has to understand what they agree to.
# Interacting with PRs # Interacting with PRs
@ -90,8 +90,8 @@ Remember, be respectful.
Entities invest their free time and motivation into making these changes, Entities invest their free time and motivation into making these changes,
treat them appropiately. treat them appropiately.
- Since in iOwO, we mostly work based on forks, [git's remotes] work fairly good - 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) - Replace things in pointy brackets (`<>`) respectively (and remove the pointy brackets).
## Initial steps for a new contributor or new local checkout ## Initial steps for a new contributor or new local checkout
@ -102,8 +102,8 @@ git remote update <contributor-name>
## After setting up the remote ## After setting up the remote
- You can repeat this step anytime you want to switch branches or update your local checkout - 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 (`:`) - The PR branch is visible just below the PR title on Forgejo, after the colon (`:`).
```sh ```sh
git switch <pr-branch> git switch <pr-branch>