Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,20 @@
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

On most pages of CatDat, you will find a suggestion form at the bottom. Use it to contribute new data, report an issue, or make a suggestion. After submission, the form automatically creates a GitHub issue, which we then review and try to resolve and implement.

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.

Expand Down Expand Up @@ -153,6 +157,15 @@ 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
### Responsible Use of AI

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.
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.
26 changes: 13 additions & 13 deletions src/routes/contribute/+page.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,19 @@
to everyone. It also does not require following any guidelines for adding new data.
</p>

<h3>Option 2: Create a Pull Request</h3>
<h3>Option 2: Create an Issue</h3>

<p>
Create an
<a
class="accent"
href="https://github.com/ScriptRaccoon/CatDat/issues/new"
target="_blank">issue</a
>
on GitHub. You will need a GitHub account.
</p>

<h3>Option 3: Create a Pull Request</h3>

<p>
Create a
Expand All @@ -65,16 +77,4 @@
>.
</p>

<h3>Option 3: Create an Issue</h3>

<p>
Create an
<a
class="accent"
href="https://github.com/ScriptRaccoon/CatDat/issues/new"
target="_blank">issue</a
>
on GitHub. You will need a GitHub account.
</p>

<SuggestionForm />