Documentation updates.

Author: RyanLamansky

CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# Contribution to SQL Server Simulator
+
+## Bugs & Feature Requests
+
+- Issues for bugs and feature requests are welcome, but please check for an existing issue first.
+- Include an example of the desired outcome.
+
+## Contributing Code
+
+- You must be the legal owner of your code and you must be willing to surrender it to this project's license.
+- Code additions and changes should be the _absolute minimum required_ to achieve your goal.
+- Formatting or style changes may only be combined with bug fixes or new features, and can only reformat the modified area.
+- Introducing a new 3rd party dependency is not permitted.
+
+If you make a PR that is rejected for any reason, but still has useful qualities, those changes might be extracted and integrated anyway.
+To avoid this and ensure repository history associates your contributions to _you_, make sure your PR is in an acceptable state so it can be directly merged as-is.

Example/Program.cs

@@ -35,7 +35,7 @@ sealed class ExampleRecord
     public required int Id { get; set; }
 }
 
-// Below is the minimum require to get entity framework to use the simulation.
+// Below is the minimum required to get entity framework to use the simulation.
 sealed class SimulatedContext(Simulation simulation) : DbContext
 {
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
@@ -45,4 +45,4 @@ protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     }
 
     public DbSet<ExampleRecord> ExampleRecord => Set<ExampleRecord>();
-}
+}

README.md

@@ -1,6 +1,6 @@
 # SQL Server Simulator for .NET
 
-Provides in-memory SQL Server emulation, intended for high performance parallel unit testing of .NET applications.
+Provides embedded SQL Server emulation, intended for high performance parallel unit testing of .NET applications.
 
 # Example
 
@@ -42,7 +42,7 @@ sealed class ExampleRecord
     public required int Id { get; set; }
 }
 
-// Below is the minimum require to get entity framework to use the simulation.
+// Below is the minimum required to get entity framework to use the simulation.
 sealed class SimulatedContext(Simulation simulation) : DbContext
 {
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
@@ -55,11 +55,27 @@ sealed class SimulatedContext(Simulation simulation) : DbContext
 }
 ```
 
-## Capabilities
+## Limitations
 
-* Not much yet; working toward supporting the basic functionality of Entity Framework Core.
+The feature set of this library is currently too small for use in real-world applications.
 
-## Limitations
+- Feature parity with SQL Server is less than 1%.
+- No thread-safety or lock emulation.
+- Syntax validation is prone to both false positives _and_ negatives due to limited feature support.
+
+## Development Priorities
+
+- The highest priority is improving SQL command processing enough to support all Entity Framework features, enabling the real-world use case of fast single-threaded unit testing of an Entity Framework-based app without requiring a SQL Server deployment.
+
+The remaining priorities are so far below the EF compatibility goal that they won't be seriously started until it's done.
+This project only has one main developer and that developer's time and motivation are limited, so an ETA is impossible.
 
-* Doesn't support most SQL Server features, probably won't work for you in its current state. Feature parity is an ongoing challenge.
-* Limited ability to check invalid syntax, since it generally assumes the source query is doing something not yet supported if it runs into trouble parsing.
+- Thread-safe concurrency on a single simulation, enabling parallel unit testing.
+- Realistic lock emulation, enabling deadlock testing.
+- Unreliable connection simulation, to enable testing of application-side recovery/retry mechanisms.
+- Support commonly-used non-Entity Framework features.
+- Usage metrics, enabling test validation of proper techniques, such as avoiding looped queries or excessive parameter counts.
+- Physical storage of data, enabling larger-than-RAM databases and faster initialization.
+- Network protocol emulation, enabling applications to connect to the simulator as if it were a real SQL Server.
+  - This almost certainly would be a separate library as it introduces a variety of new network and cryptography dependencies compared to the core engine which has no dependencies outside of .NET itself.
+  - Following this would be work to enable compatibility with tools like SQL Server Management Studio.

SqlServerSimulator.sln

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 17
-VisualStudioVersion = 17.1.31911.260
+# Visual Studio Version 18
+VisualStudioVersion = 18.3.11218.70 d18.3
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SqlServerSimulator", "SqlServerSimulator\SqlServerSimulator.csproj", "{CF5684B4-08DF-4CD3-8342-5B627155B40A}"
 EndProject
@@ -10,6 +10,7 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{527F1E6C-BCEE-442F-96C4-B0ED5E47B5EE}"
 	ProjectSection(SolutionItems) = preProject
 		.editorconfig = .editorconfig
+		CONTRIBUTING.md = CONTRIBUTING.md
 		.github\workflows\dotnetcore.yml = .github\workflows\dotnetcore.yml
 		README.md = README.md
 	EndProjectSection