diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..f9d999f --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,15 @@ +All documentation, branch names, variable and method names, and comments must use American English. Pull request titles and commit messages must also be in English. +Do not create additional AGENTS.md files. +Do not use the `--no-build` parameter when running the application or tests, as it leads to missing libraries. +All tests should use xUnit with the FluentAssertions package. +Information about available classes and methods from the standard List and List operations is documented in README.md. Additional compatibility methods are distributed across NuGet packages. +Before adding, modifying, or removing methods or classes, review the README files from related repositories (links are included below). +Projects and tests must target .NET 8 by default and also support .NET 9, .NET 7, and .NET 6. Use the latest available C# language features when possible. + +## Related NuGet packages +- [Recyclable.Collections](https://github.com/mlemanczyk/Recyclable.Collections/blob/main/README.md) +- [Recyclable.Collections.Compatibility.List](https://github.com/mlemanczyk/Recyclable.Collections.Compatibility.List/blob/master/README.md) +- [Recyclable.Collections.Concurrent](https://github.com/mlemanczyk/Recyclable.Collections.Concurrent/blob/master/README.md) +- [Recyclable.Collections.Linq](https://github.com/mlemanczyk/Recyclable.Collections.Linq/blob/master/README.md) +- [Recyclable.Collections.Searching](https://github.com/mlemanczyk/Recyclable.Collections.Searching/blob/master/README.md) +- [Recyclable.Collections.TestData](https://github.com/mlemanczyk/Recyclable.Collections.TestData/blob/master/README.md) diff --git a/README.md b/README.md index 0a6a14e..6c72333 100644 --- a/README.md +++ b/README.md @@ -1 +1,15 @@ -# Recyclable.Collections.Searching \ No newline at end of file +# Recyclable.Collections.Searching + +`Recyclable.Collections.Searching` is an open source project providing high performance search extensions for recyclable lists. The goal is minimal memory footprint and straightforward APIs. + +## Planned features +- Search helpers for `RecyclableList` +- Search helpers for `RecyclableLongList` + +## Related NuGet packages +- [Recyclable.Collections](https://github.com/mlemanczyk/Recyclable.Collections/blob/main/README.md) +- [Recyclable.Collections.Compatibility.List](https://github.com/mlemanczyk/Recyclable.Collections.Compatibility.List/blob/master/README.md) +- [Recyclable.Collections.Concurrent](https://github.com/mlemanczyk/Recyclable.Collections.Concurrent/blob/master/README.md) +- [Recyclable.Collections.Linq](https://github.com/mlemanczyk/Recyclable.Collections.Linq/blob/master/README.md) +- [Recyclable.Collections.Searching](https://github.com/mlemanczyk/Recyclable.Collections.Searching/blob/master/README.md) +- [Recyclable.Collections.TestData](https://github.com/mlemanczyk/Recyclable.Collections.TestData/blob/master/README.md)