Repository navigation
Revise CONTRIBUTING.md and add AI policy #10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,20 @@ | ||
| # Contributing | ||
|
|
||
| We are really happy that you want to contribute. | ||
| To help you get started please read this document. | ||
| We are really happy that you want to contribute. To help you get started, please read this document. | ||
|
|
||
| ## Current tech stack | ||
| ## Tooling | ||
|
|
||
| We currently moved from Obsidian to plain markdown so there you might encounter | ||
| some artifacts. (Feel free to create a PR). | ||
| Please use [rumdl](https://rumdl.dev) to lint and format your Markdown. | ||
| Also, spell-check your work using something like <https://languagetool.org/>. Both of these are also done in CI. | ||
|
|
||
| If possible please use rumdl or similar for uniform markdown formatting. | ||
| ## Style | ||
|
|
||
| Our docs are supposed to be tutorial-like and beginner-friendly. For technical details, explain them in the glossary at the bottom of a guide | ||
| or link to a source, if the reader wants to go down a rabbit hole that's fine. You are free to use colloquial language if that improves the flow of the text. | ||
|
|
||
| ## AI policy | ||
|
|
||
| Please do not submit AI/LLM-generated writing. LLMs are useful for many thing, writing prose is not one of them. | ||
|
oskardotglobal marked this conversation as resolved.
Resolved
|
||
| Our docs are written by humans who put a lot of effort into having a nice end result. Many readers can tell if writing was AI-generated and | ||
| that doesn't accurately reflect the time that goes into working on these docs. If we were to just have LLMs write our docs, | ||
| there is little benefit to the reader -- they might as well ask their LLM of choice instead of referring to our resources. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.