From f6a8f0a7890dcb87e9d0a8b5dd5394e0c8fca057 Mon Sep 17 00:00:00 2001 From: nojaf Date: Fri, 15 Mar 2024 11:23:43 +0100 Subject: [PATCH] Add pull request template. --- .github/pull_request_template.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..42f56013 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ +# Before you go + +Hi there! Thank you for your contribution to our project. To help maintain the quality of our codebase, our Continuous Integration (CI) system will automatically run several checks on your submission. To streamline the process, we kindly ask you to perform these checks locally before pushing your changes: + +To execute all build scripts, please run: + +```shell +dotnet fsi build.fsx +``` + +If you encounter any formatting issues, you can auto-correct them by running: + +```shell +dotnet fantomas build.fsx src tests docs +``` + +Should any tests fail, please review and adjust your changes accordingly. + +We appreciate your efforts to contribute and look forward to reviewing your pull request!