katzen-cafe/iowo
2
4
Fork 1
Code Issues 4 Pull requests 2 Projects Releases Packages Wiki Activity

docs: some initial groundwork #2

Merged
multisamplednight merged 26 commits from :initial-docs into main 2024-01-20 19:00:52 +00:00
Conversation 25 Commits 26 Files changed 13 +19 -19
1 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 53cc3f26dd - Show all commits

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:
multisamplednight marked this conversation as resolved Outdated
schrottkatze commented 2024-01-18 18:47:20 +00:00
Outdated
Review
Copy link

Maybe replace the dot with a colon, that feels more correct due to the following enumeration

Maybe replace the dot with a colon, that feels more correct due to the following enumeration
multisamplednight commented 2024-01-18 21:25:39 +00:00
Outdated
Review
Copy link

Tbh then I'd rather completely remove the dots at the end, would that be fine, too?

Tbh then I'd rather completely remove the dots at the end, would that be fine, too?
schrottkatze commented 2024-01-18 22:45:16 +00:00
Outdated
Review
Copy link

I meant specifically in the last thingy, like this:

- 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?
I meant specifically in the last thingy, like this: ``` - 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? ```
- 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
multisamplednight marked this conversation as resolved Outdated
schrottkatze commented 2024-01-18 18:54:12 +00:00
Outdated
Review
Copy link

is this supposed to render a certain way? it just shows the [!NOTE] when rendered

is this supposed to render a certain way? it just shows the `[!NOTE]` when rendered
multisamplednight commented 2024-01-18 21:28:42 +00:00
Outdated
Review
Copy link

It does in some markdown viewers such as Obsidian or GitHub, but apparently not on Forgejo. I'll remove it then.

It does in some markdown viewers such as Obsidian or GitHub, but apparently not on Forgejo. I'll remove it then.
@ -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
multisamplednight marked this conversation as resolved Outdated
schrottkatze commented 2024-01-20 18:00:19 +00:00
Outdated
Review
Copy link

that reads a bit weird to me, maybe rephrase to:

-- Since in iOwO, we mostly work based on forks, [git's remotes] work fairly good.
+- Since we mostly work using forks, [git's remotes] work fairly well.
that reads a bit weird to me, maybe rephrase to: ```diff -- Since in iOwO, we mostly work based on forks, [git's remotes] work fairly good. +- Since we mostly work using forks, [git's remotes] work fairly well. ```
@ -102,8 +102,8 @@ git remote update <contributor-name>
## After setting up the remote ## After setting up the remote
multisamplednight marked this conversation as resolved Outdated
schrottkatze commented 2024-01-18 18:57:09 +00:00
Outdated
Review
Copy link

Forgejo with a capital F since this is a document (so ig spelling is important) and forgejo is a name mew

Forgejo with a capital F since this is a document (so ig spelling is important) and forgejo is a name mew
- 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>