Skip to content

Commit c5756b1

Browse files
committed
update contribution guidelines, mention small PRs
1 parent 551cc33 commit c5756b1

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ More info can be found in GitHub's help section:
3535

3636
### Local Setup
3737

38-
You need to have [NodeJS](https://nodejs.org/) and [pnpm](https://pnpm.io/) installed.
38+
You need to have [Git](https://git-scm.com/), [NodeJS](https://nodejs.org/) and [pnpm](https://pnpm.io/) installed.
3939

4040
1. Fork `ScriptRaccoon/CatDat` on GitHub.
4141
2. Clone your fork with `git clone https://github.com/{your_username}/CatDat.git`.
@@ -91,6 +91,7 @@ If any of these tests fail, adjust the data accordingly.
9191
- [Add "locally cartesian closed" property](https://github.com/ScriptRaccoon/CatDat/pull/3/changes)
9292
- [Add "locally strongly finitely presentable" as a property](https://github.com/ScriptRaccoon/CatDat/pull/21/changes)
9393
- [Add filtered and cofiltered categories](https://github.com/ScriptRaccoon/CatDat/pull/40/changes)
94+
- [Add the simplex category](https://github.com/ScriptRaccoon/CatDat/pull/81)
9495

9596
### Guidelines for Adding New Data
9697

@@ -128,6 +129,21 @@ When contributing new data (categories, functors, properties, implications), ple
128129

129130
- **New Combinations**: Add new categories that satisfy combinations of satisfied properties and unsatisfied properties and not yet in the database. For example, you may add a category that is abelian but neither cocomplete nor essentially small (if it is not already present). The [page with missing data](https://catdat.app/missing) lists consistent combinations of the form $p \land \neg q$ that are not yet witnessed by a category in the database. The same remarks apply to functors.
130131

132+
### Keep Pull Requests Focused
133+
134+
Please keep each pull request limited in scope. Large pull requests are harder to review, more likely to conflict with ongoing changes on the main branch, and more difficult to merge cleanly.
135+
136+
If you plan to contribute multiple additions or improvements, split the work into several smaller pull requests and submit them one at a time. A pull request cannot be too small, but it can certainly be too large.
137+
138+
Examples of appropriate pull requests include:
139+
140+
- adding a single category property and determining it for several categories in the database,
141+
- adding a single category together with its properties,
142+
- adding a single missing proof ([Example](https://github.com/ScriptRaccoon/CatDat/pull/27))
143+
- clarifying definitions, explanations, or documentation.
144+
145+
As a practical guideline, avoid introducing more than four properties (or four categories) in a single pull request.
146+
131147
### Conventions
132148

133149
1. Use `\varnothing` to display the empty set, not `\emptyset`.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This project is a **community effort**. Whether you're a mathematician spotting
3737

3838
## Local Setup
3939

40-
You need to have [NodeJS](https://nodejs.org/) and [pnpm](https://pnpm.io/) installed.
40+
You need to have [Git](https://git-scm.com/), [NodeJS](https://nodejs.org/) and [pnpm](https://pnpm.io/) installed.
4141

4242
1. Fork `ScriptRaccoon/CatDat` on GitHub.
4343
2. Clone your fork with `git clone https://github.com/{your_username}/CatDat.git`.

0 commit comments

Comments
 (0)