You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 83d898a
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,14 +89,17 @@ Here is a brief overview of our main projects (also available [here](https://git
89
89
90
90
### Build process
91
91
92
-
Our F# projects use the [ProjectScaffold](https://github.com/fsprojects/ProjectScaffold) layout. To build our projects, you will need [.NET Core SDK](https://dotnet.microsoft.com/download)and an installation of [FAKE5 CLI]().
92
+
The build is driven by a [FAKE](https://fake.build/) build project in `build/`, invoked through the `build.cmd` / `build.sh` wrappers. You need the [.NET SDK](https://dotnet.microsoft.com/download)version pinned in `global.json`.
93
93
94
-
All projects have at least the following build targets:
94
+
The most important build targets:
95
95
96
-
|Target|Description|Command Line Arguments|
96
+
|Target|Description|Command Line|
97
97
|---|---|---|
98
-
|Build|Builds the binaries and docs|fake build|
99
-
|ReleaseLocal|Uses Build. Afterwards creates a folder structure so you can see the docs with proper style and relative paths in temp/localDocs. Use this to test documentation. | fake build --target releaselocal|
98
+
|BuildSolution (default)|Cleans and builds the solution|`./build.cmd`|
99
+
|RunTests|Builds and runs the test suite|`./build.cmd runtests`|
100
+
|RunTestsWithCodeCov|Runs the tests with AltCover coverage (writes `codeCov.xml`)|`./build.cmd runtestswithcodecov`|
101
+
|BuildDocs|Builds the documentation site into `output/` (run `dotnet tool restore` once first)|`./build.cmd builddocs`|
102
+
|WatchDocs|Serves the docs locally with live reload (run `dotnet tool restore` once first). Use this to test documentation.|`./build.cmd watchdocs`|
100
103
101
104
## How can i contribute?
102
105
@@ -196,11 +199,11 @@ One of our biggest weakness at the moment are unit tests. We will love everyone
196
199
197
200
### Documentation guidelines
198
201
199
-
The docs in our repos are built by the [F# Formatting Documentation tools](http://fsprojects.github.io/FSharp.Formatting/) which parse`.fsx` files in the docsrc/content folder to generate html files. Again, no strict rules here, just a few minor guidelines:
202
+
The docs in our repos are built by [fsdocs](https://fsprojects.github.io/FSharp.Formatting/)(the `fsdocs-tool` pinned in `.config/dotnet-tools.json`), which turns`.md` and `.fsx` files in the `docs/` folder into the html site and generates the API reference from the compiled assemblies. Again, no strict rules here, just a few minor guidelines:
200
203
201
-
* If you add or change functionality to a project, please consider adding/changing the respective documentation script. If you dont have time to do that, please comment it on your pull request.
204
+
* If you add or change functionality to a project, please consider adding/changing the respective documentation page. If you dont have time to do that, please comment it on your pull request.
202
205
203
-
* Most documentation is written in a tutorial-style manner. If you use external files in your examples, put them into docsrc/content/data.
206
+
* Most documentation is written in a tutorial-style manner. If you use external files in your examples, put them under `docs/`.
204
207
205
208
* API References are built from triple frontslash comments (`///`), please consider adding those above the functions/types/classes you are adding.
0 commit comments