Skip to content

Commit

Permalink
move DevelopersChatGPTToolBench files out of the way
Browse files Browse the repository at this point in the history
  • Loading branch information
stoerr committed Oct 12, 2023
1 parent 0abda01 commit 0ba93c4
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion chatgpt.codeRules.md → .chatgpt.codeRules.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- Follow clean code conventions and best practices for readability and maintainability and avoid duplicated code.
- First read in the files that seem relevant for the task. Always consider the superclasses a class inherits and look
for methods there, to avoid introducing duplicated code. Check whether there is already similar code to draw on.
- If the content of other files might be important for your task, please read them without asking.
- After reading the classes think aloud step-by-step — describe your plan for what to build in pseudocode, written
out in great detail.
If there are several ways to do the task, discuss them and choose the best one to make sure the changes are correct
Expand All @@ -22,6 +23,5 @@
are available (e.g. for executing a build).
- Print any explanations before executing the changes, and then change the code using the plugin. Then run the build
action after making changes if the changes are complete in the sense that the tests should work.
- Important: If the content of other files might be important for your task, please read them without asking.
- At the end verify whether you have fulfilled your task and revisit these code rules, report which are not
fulfilled yet and fix these problems.
4 changes: 2 additions & 2 deletions .chatgpt.intro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Read the chatgpt.codeRules.md and observe the rules that are laid out there
during this whole chat, but you don't need to repeat them.
List all files except ui.content.sample using the plugin. Read the .chatgpt.codeRules.md and observe the rules that
are laid out there during this whole chat, but you don't need to repeat them.

Use the grep operation to search for comments starting with `ChatGPTTask:` and execute them. The comment should be
replaced by the new code or deleted when it's completely done.
8 changes: 6 additions & 2 deletions docindex.md → .docindex.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@ This file serves as an index for all .md files in the project. It provides a bri

Generated with ChatGPT plugin [DevelopersChatGPTToolBench](https://github.com/stoerr/DevelopersChatGPTToolBench) and
prompt:
Create a file docindex.md that contains an index of all .md files in the project, as a helper for locating a documentation. For each .md file it should have an entry that tells what information is found there. (Not a summary - the file should help to find the right .md file). Index only markdown files which are named with extension .md, nothing else.
Go step by step: first check what entries docindex.md already has, then list what .md files are there, read a .md file for which there is no entry yet and create it in docindex.md, until all files are indexed.
Create a file .docindex.md that contains an index of all .md files in the project, as a helper for locating a
documentation. For each .md file it should have an entry that tells what information is found there. (Not a summary -
the file should help to find the right .md file). Index only markdown files which are named with extension .md, nothing
else.
Go step by step: first check what entries docindex.md already has, then list what .md files are there, read a .md file
for which there is no entry yet and create it in docindex.md, until all files are indexed.

## The index

Expand Down

0 comments on commit 0ba93c4

Please sign in to comment.