You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+13-18Lines changed: 13 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -190,24 +190,19 @@ Translations are managed via Crowdin: https://crowdin.com/project/qownnotes
190
190
191
191
## Important Notes for AI Assistants
192
192
193
-
1.**Always use `just src-build` to build the project** - Don't try to run qmake/make directly unless specifically requested
194
-
2.**Always use `just nix-build` to build the project when asked to use nix**
195
-
3.**The project uses Qt/C++** - Be mindful of Qt's signal/slot mechanism, QObject lifecycle, and Qt-specific patterns
196
-
4.**Submodules are used** - Libraries in `src/libraries/` are git submodules
197
-
5.**Multiple Qt versions supported** - Code must work with both Qt5 and Qt6
198
-
6.**Cross-platform** - Code must work on Linux, macOS, and Windows
199
-
7.**Two build systems available** - Primary is qmake (`.pro` files), but CMake (`CMakeLists.txt`) is also supported
200
-
8.**Build projects** - The primary build project files are `src/QOwnNotes.pro` and `src/CMakeLists.txt`
201
-
9.**Development mode** - Use `CONFIG+=DEV_MODE` for qmake or `-DDEV_MODE=ON` for CMake in active development
202
-
10.**Version bumping** - Update `src/version.h` and `src/build_number.h`, `BUILD` just needs to be increase by one
203
-
- Version format is `MAJOR.MINOR.PATCH` (e.g. `22.12.0`), build number is a separate integer that increments with each release
204
-
- The MAJOR part is always the last two digits of the year of the release (e.g. `22` for 2022),
205
-
- The MINOR part is the month of the release (e.g. `12` for December),
206
-
- The PATCH part is a counter that starts at `0` and increments with each release in the same month
207
-
(e.g. `0` for the first release in December 2022, `1` for the second release in December 2022, etc.)
208
-
11.**This project has translations** - They can be found in the `src/translations/` directory as `.ts` files
209
-
12.**Comments** - Always write clear and concise comments for complex logic, especially when dealing with Qt-specific features, start comments with uppercase letters
210
-
13.**Changelog** - Update the changelog with each release, following the format in `CHANGELOG.md`
193
+
-**Always use `just nix-build` to build the project** - Don't try to run qmake/make directly unless specifically requested
194
+
-**The project uses Qt/C++** - Be mindful of Qt's signal/slot mechanism, QObject lifecycle, and Qt-specific patterns
195
+
-**Submodules are used** - Libraries in `src/libraries/` are git submodules
196
+
-**Multiple Qt versions supported** - Code must work with both Qt5 and Qt6
197
+
-**Cross-platform** - Code must work on Linux, macOS, and Windows
198
+
-**Two build systems available** - Primary is qmake (`.pro` files), but CMake (`CMakeLists.txt`) is also supported
199
+
-**Build projects** - The primary build project files are `src/QOwnNotes.pro` and `src/CMakeLists.txt`
200
+
-**Development mode** - Use `CONFIG+=DEV_MODE` for qmake or `-DDEV_MODE=ON` for CMake in active development
201
+
-. **Version bumping** - Update `src/version.h` and `src/build_number.h`, `BUILD` just needs to be increase by one - Version format is `MAJOR.MINOR.PATCH` (e.g. `22.12.0`), build number is a separate integer that increments with each release - The MAJOR part is always the last two digits of the year of the release (e.g. `22` for 2022), - The MINOR part is the month of the release (e.g. `12` for December), - The PATCH part is a counter that starts at `0` and increments with each release in the same month
202
+
(e.g. `0` for the first release in December 2022, `1` for the second release in December 2022, etc.)
203
+
-**This project has translations** - They can be found in the `src/translations/` directory as `.ts` files
204
+
-**Comments** - Always write clear and concise comments for complex logic, especially when dealing with Qt-specific features, start comments with uppercase letters
205
+
-**Changelog** - Update the changelog with each release, following the format in `CHANGELOG.md`
0 commit comments