Skip to content

Commit 96d979f

Browse files
committed
Added some information about tenets
1 parent 9e06180 commit 96d979f

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,29 @@ We have adopted a [code of conduct](https://github.com/csharpfritz/InstantAPIs/b
2020

2121
## What should I know before I get started?
2222

23-
This project is currently a proof-of-concept library that generates Minimal API endpoints for an Entity Framework context.
23+
This project is currently a proof-of-concept library that generates Minimal API endpoints for an Entity Framework context. You should be
24+
familiar with C# 10, .NET 6, ASP.NET Core, and Entity Framework Core. Reflection and Source Generators are a plus as this project will use those
25+
.NET features to generate HTTP APIs.
26+
2427
### Project Folder Structure
2528

2629
The folders are a basic structure which will change as needed to support the project as it grows. The folders are configured as follows:
2730

2831
```
2932
3033
Fritz.InstantAPIs The project code.
31-
WorkingApi The project to test the functionality being developed.
34+
WorkingApi The project to prototype and manually test the functionality being developed.
3235
3336
```
3437

3538
### Design Decisions
3639

3740
Design for this project is ultimately decided by the project lead, [Jeff Fritz](https://github.com/csharpfritz). The following project tenets are adhered to when making decisions:
3841

42+
1. This is a library to help make the simple API endpoints that every project needs.
43+
1. This library is not intended to generate more complex API endpoints.
44+
1. This toolset should help users to deliver APIs with .NET on any and all ASP.NET Core supported platforms
45+
3946
## How can I contribute?
4047

4148
We are always looking for help on this project. There are several ways that you can help:

0 commit comments

Comments
 (0)