[
https://issues.apache.org/jira/browse/SOLR-18076?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18055366#comment-18055366
]
Jan Høydahl commented on SOLR-18076:
------------------------------------
I just learned about Github's spec-kid ([https://github.com/github/spec-kit]).
It's fairly new and I have not tried it for real. It seems to be gathering
momentum and may become some kind of standard or convention for a structured
approach to AI coding. Spec-kit has a working folder {{.specify}} with some
predefined structure, and sub folders where you can write a spec for a feature,
develop a plan, then concrete steps to break up the elephant.
In the context of this JIRA, I noticed that this may answer the question of
where to put the above list of principles. Spec-kit defines a constitution file
in {{.specify/memory/constitution.md}} which is supposed to list the
fundamental principles that are important to a project. So we could use that as
a well-known location, even if we don't embrace the rest of spec-kit. I'll
definitely give spec-kit a go also for feature development, but that is another
and bigger discussion.
So if we put the file at that location, how to tell devs not using spec-kit how
to include it into their coding agent. I suppose each tool has its own way to
import a file, claude code has the {{@/path/to/file}} syntax...
> Add a PROMPTING.md or similar for AI agents
> -------------------------------------------
>
> Key: SOLR-18076
> URL: https://issues.apache.org/jira/browse/SOLR-18076
> Project: Solr
> Issue Type: Wish
> Reporter: Jan Høydahl
> Priority: Major
>
> I came across
> [https://vibe-coding-manifesto.com|https://vibe-coding-manifesto.com/] which
> outlines several best practices for AI contributions to a project. We encode
> some of these already in
> [https://github.com/apache/solr/pull/3946|https://github.com/apache/solr/pull/3946.].
> But there is a recommendation for a {{PROMPTING.md}} file in the git repo to
> help AI agents follow project guidelines and preferences.
> This Jira is to discuss whether we should add such a file and what it should
> contain. Until there is a formal standard for such files, it seems as
> {{PROMPTING.md}} is the best choice.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
