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 +28 -1
1 changed files with 28 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit a9b69094cc - Show all commits

29
CONTRIBUTING.md
View file

@ -82,6 +82,33 @@ If you want to contribute art or the like, do that in whatever **you** are most
- 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
> [!NOTE] Remember, be respectful.
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.
> 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).
## Initial steps for a new contributor or new local checkout
```sh
git remote add <contributor-name> https://forge.katzen.cafe/<contributor-account>/iowo.git
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. ```
git remote update <contributor-name>
```
## 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 (`:`).
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
```sh
git switch <pr-branch>
git pull
```
[code of conduct]: ./CODE_OF_CONDUCT.md [code of conduct]: ./CODE_OF_CONDUCT.md
[informed consent]: https://en.wikipedia.org/wiki/Informed_consent [informed consent]: https://en.wikipedia.org/wiki/Informed_consent
[git's remotes]: https://git-scm.com/docs/git-remote