Skip to content

Commit 7eec9e5

Browse files
added some quick links and a page giving some contribution guidelines.
1 parent f74510d commit 7eec9e5

2 files changed

Lines changed: 31 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Contribution guidelines
2+
3+
Contributions to this repository are welcome, you can engage with users and contributors on Gitter:
4+
5+
## Code and documentation contributions:
6+
7+
There is very low bar for submitting a PR for review and discussion, changes to code that will get merged will generally requires a bit of back and forth beyond simplest fixes.
8+
9+
### Contributing to the docs
10+
11+
The best way is to pull the repository and build it, then you can use those FAKE build targets (run a single target with `build.cmd TargetName -st` if you don't want to start from a clean build):
12+
13+
* **GenerateDocs** : Will run FSharp.Formatting over the ./docs/contents folder.
14+
* **ServeDocs** : Will run IIS Express to serve the docs, and then show the home URL with your default browser.
15+

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
1-
# SqlClient providers
1+
# FSharp.Data.SqlClient - Type providers for Microsoft SQL Server
22

3-
## SqlCommandProvider
3+
This library exposes SQL Server Database objects in a type safe manner to F# code, by the mean of [Type Providers](https://docs.microsoft.com/en-us/dotnet/fsharp/tutorials/type-providers/)
44

5-
Provides statically typed access to input parameters and result set of T-SQL command in idiomatic F# way.
5+
## Quick Links
6+
* [Documentation](http://fsprojects.github.io/FSharp.Data.SqlClient/)
7+
* [Release Notes](RELEASE_NOTES.md)
8+
* [Contribution Guide Lines](CONTRIBUTING.md)
9+
* [Gitter Chat Room](https://gitter.im/FSharp-Data-SqlClient/community)
10+
11+
## Type Providers
12+
13+
### SqlCommandProvider
14+
15+
Provides statically typed access to the parameters and result set of T-SQL command in idiomatic F# way <sup>(*)</sup>.
616

717
```fsharp
818
open FSharp.Data
@@ -30,7 +40,7 @@ seq
3040
("Tete", "Mensa-Annan", 1576562.1966M)]
3141
```
3242

33-
## SqlProgrammabilityProvider
43+
### SqlProgrammabilityProvider
3444

3545
Exposes Tables, Stored Procedures, User-Defined Types and User-Defined Functions in F# code.
3646

@@ -52,7 +62,7 @@ ProductAssemblyID: 750, StandardCost: 2171.2942, TotalQuantity: 1.00
5262
ProductAssemblyID: 751, StandardCost: 2171.2942, TotalQuantity: 1.00
5363
```
5464

55-
## SqlEnumProvider
65+
### SqlEnumProvider
5666

5767
Let's say we need to retrieve number of orders shipped by a certain shipping method since specific date.
5868

@@ -76,7 +86,7 @@ output
7686
Some (Some 1085)
7787
```
7888

79-
## SqlFileProvider
89+
### SqlFileProvider
8090

8191
```fsharp
8292
type SampleCommand = SqlFile<"sampleCommand.sql">

0 commit comments

Comments
 (0)