From 459f440fdf5366dc09c2927d159d1aef305e7885 Mon Sep 17 00:00:00 2001 From: Script Raccoon Date: Sat, 2 May 2026 10:20:43 +0200 Subject: [PATCH 1/2] change order of contribution options --- CONTRIBUTING.md | 14 +++++++------- src/routes/contribute/+page.svelte | 26 +++++++++++++------------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a141caeb..6053626c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,8 +5,8 @@ There are three ways to contribute: - [Use the Suggestion Form](#option-1-use-the-suggestion-form) -- [Create a Pull Request](#option-2-create-a-pull-request) -- [Create an Issue](#option-3-create-an-issue) +- [Create an Issue](#option-2-create-an-issue) +- [Create a Pull Request](#option-3-create-a-pull-request) ## Option 1: Use the Suggestion Form @@ -14,7 +14,11 @@ On most pages of CatDat, you will find a suggestion form at the bottom. Use it t This option does not require any knowledge of GitHub or coding, making it accessible to everyone. It also does not require following any guidelines for adding new data (see below). -## Option 2: Create a Pull Request +## Option 2: Create an Issue + +If you want to report a bug or submit a feature request, you can [**create an issue**](https://github.com/ScriptRaccoon/CatDat/issues/new). You will need a GitHub account for this. + +## Option 3: Create a Pull Request Create a [**pull request**](https://github.com/ScriptRaccoon/CatDat/pulls). You will need a GitHub account. @@ -152,7 +156,3 @@ As a practical guideline, avoid introducing more than four properties (or four c 1. Use `\varnothing` to display the empty set, not `\emptyset`. 2. Write `non-empty`, not `nonempty`. Same for `non-unital`, `non-expansive`, etc. - -## Option 3: Create an Issue - -If you want to report a bug or submit a feature request, you can [**create an issue**](https://github.com/ScriptRaccoon/CatDat/issues/new). You will need a GitHub account for this. diff --git a/src/routes/contribute/+page.svelte b/src/routes/contribute/+page.svelte index f271852e..ee9fa78e 100644 --- a/src/routes/contribute/+page.svelte +++ b/src/routes/contribute/+page.svelte @@ -49,7 +49,19 @@ to everyone. It also does not require following any guidelines for adding new data.

-

Option 2: Create a Pull Request

+

Option 2: Create an Issue

+ +

+ Create an + issue + on GitHub. You will need a GitHub account. +

+ +

Option 3: Create a Pull Request

Create a @@ -65,16 +77,4 @@ >.

-

Option 3: Create an Issue

- -

- Create an - issue - on GitHub. You will need a GitHub account. -

- From 320e4c00444acce04c4dad95d8b2438c358ce6e0 Mon Sep 17 00:00:00 2001 From: Script Raccoon Date: Sat, 2 May 2026 10:40:48 +0200 Subject: [PATCH 2/2] add rules for responsible use of AI --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6053626c..aea6fca6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -156,3 +156,16 @@ As a practical guideline, avoid introducing more than four properties (or four c 1. Use `\varnothing` to display the empty set, not `\emptyset`. 2. Write `non-empty`, not `nonempty`. Same for `non-unital`, `non-expansive`, etc. + +### Responsible Use of AI + +AI tools may be used to assist with development in this repository, but not to replace the act of programming. + +- Use AI to support your workflow (e.g. by asking questions, getting suggestions, or creating snippets), not to generate complete features or large portions of code without your active involvement. +- AI agents that autonomously generate or modify code are not allowed. Pull requests that are mainly written by AI agents will be closed. +- AI can also be used to find proofs for properties of categories, but they must be checked thoroughly and written in your own words. +- AI may also be used to improve English writing (e.g. grammar, clarity, phrasing), particularly if you are not a native speaker. +- Every line of code in a pull request must be understood by the developer submitting it. +- Pull request descriptions and commit messages must be written manually. AI-generated summaries are often superficial, meaningless, and do not tell the whole story. + +In summary, treat AI as a productivity tool, not as a substitute for understanding or authorship.