Skip to content

Commit 2b470c0

Browse files
Copilotjongalloway
andcommitted
Clarify prerelease status and production-quality goals in custom-instructions.md
Co-authored-by: jongalloway <[email protected]>
1 parent 6c174e6 commit 2b470c0

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

custom-instructions.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ This document provides guidance for AI assistants working with the NLWebNet code
66

77
**NLWebNet** is a .NET implementation of the [NLWeb protocol](https://github.com/microsoft/NLWeb) for building natural language web interfaces.
88

9-
### Production-Ready NuGet Package
9+
### NuGet Package Development
1010

11-
**This library is designed for production use and follows .NET best practices.**
11+
**This library is being developed for eventual production use and follows .NET best practices.**
1212

13-
- **Purpose**: Production implementation of the NLWeb protocol for .NET applications
14-
- **Current status**: Alpha prerelease (0.1.0-alpha.3) on NuGet - actively developed
13+
- **Purpose**: To create a production-quality implementation of the NLWeb protocol for .NET applications
14+
- **Current status**: Early alpha prerelease (0.1.0-alpha.3) - not yet production ready
15+
- **Development goal**: Production-ready library with high code quality standards
1516
- **Demo application**: Simple reference implementation showcasing library capabilities
1617
- **Target audience**: .NET developers building natural language web interfaces
1718

@@ -195,10 +196,11 @@ src/NLWebNet/
195196
## Limitations and Current Implementation Status
196197

197198
### Current Implementation Status
198-
- **Alpha release** - Core functionality implemented, additional features in development
199+
- **Early alpha prerelease** - Core functionality implemented, not yet production ready
199200
- **Mock data backend** as default - Real data source integrations can be implemented via `IDataBackend`
200201
- **Basic AI integration** - Extensible via Microsoft.Extensions.AI patterns
201202
- **Authentication framework** - Ready for implementation based on application requirements
203+
- **Code quality standards** - Production-level code quality maintained throughout development
202204

203205
### Performance Considerations
204206
- **Streaming responses** for better perceived performance
@@ -208,7 +210,8 @@ src/NLWebNet/
208210

209211
### Deployment Considerations
210212
- **Requires .NET 9.0** - Latest framework dependency for modern features
211-
- **Production ready** - Library designed for production deployment
213+
- **Early prerelease status** - Not yet ready for production deployment
214+
- **Production-quality code** - Library being developed with production standards
212215
- **Demo app simplicity** - Reference implementation kept simple for clarity
213216

214217
## When to Seek Clarification
@@ -220,4 +223,4 @@ Ask for guidance when:
220223
- **Protocol compliance** questions arise
221224
- **Production deployment** patterns need to be established
222225

223-
Remember: This is a production-ready library with a focus on clean, maintainable code that properly implements the NLWeb protocol for .NET applications.
226+
Remember: This library is being developed with production-quality standards, though it is currently in early prerelease and not yet ready for production use. All code additions and edits should maintain production-level quality as the project works toward its goal of becoming a production-ready NLWeb protocol implementation for .NET applications.

0 commit comments

Comments
 (0)