Skip to content

Commit d163396

Browse files
Krzysztof-CieslakKrzysztof-Cieslak
committed
Init commit
0 parents  commit d163396

File tree

155 files changed

+9686
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+9686
-0
lines changed

‎.config/dotnet-tools.json

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"version": 1,
3+
"isRoot": true,
4+
"tools": {
5+
"fake-cli": {
6+
"version": "5.19.1",
7+
"commands": [
8+
"fake"
9+
]
10+
},
11+
"paket": {
12+
"version": "5.242.2",
13+
"commands": [
14+
"paket"
15+
]
16+
}
17+
}
18+
}

‎.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.sh text eol=lf

‎.github/ISSUE_TEMPLATE/bug_report.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
### Description
2+
3+
> Short and descriptive example bug report title
4+
> A summary of the issue and the environment in which it occurs. If suitable,
5+
> include the steps required to reproduce the bug.
6+
7+
### Reproduction steps
8+
9+
> 1. This is the first step
10+
> 2. This is the second step
11+
> 3. Further steps, etc.
12+
13+
### Reproduction code
14+
15+
> `<url>` - a link to the reduced test case (e.g. a GitHub Gist)
16+
17+
### Other info
18+
19+
> Any other information you want to share that is relevant to the issue being
20+
> reported. This might include the lines of code that you have identified as
21+
> causing the bug, and potential solutions (and your opinions on their
22+
> merits).

‎.github/ISSUE_TEMPLATE/feature_request.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### Description
2+
3+
> Description of the requested feature
4+
5+
### Potential alternatives
6+
7+
> 1. This is the first step
8+
> 2. This is the second step
9+
> 3. Further steps, etc.
10+
11+
### Other info
12+
13+
> Any other information you want to share that is relevant to the feature request

‎.github/workflows/build.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Build
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
8+
strategy:
9+
matrix:
10+
os: [ubuntu-latest, windows-latest, macOS-latest]
11+
dotnet: [3.1.101]
12+
runs-on: ${{ matrix.os }}
13+
14+
steps:
15+
- uses: actions/checkout@v1
16+
- name: Setup .NET Core
17+
uses: actions/setup-dotnet@v1
18+
with:
19+
dotnet-version: ${{ matrix.dotnet }}
20+
- name: Restore tools
21+
run: dotnet tool restore
22+
- name: Restore dependencies
23+
run: dotnet restore
24+
- name: Run build
25+
run: dotnet fake build -t Pack

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.fake/
2+
packages/
3+
paket-files/
4+
nupkg/
5+
obj/
6+
bin/
7+
release.cmd
8+
.ionide/
9+
build/

‎.paket/Paket.Restore.targets

+488
Large diffs are not rendered by default.

‎.vscode/settings.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"FSharp.useSdkScripts": true
3+
}

‎CONTRIBUTING.md

+149
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
# Contributing to Saturn
2+
3+
Please take a moment to review this document in order to make the contribution
4+
process easy and effective for everyone involved!
5+
6+
## Using the issue tracker
7+
8+
Use the issues tracker for:
9+
10+
* [bug reports](#bug-reports)
11+
* [feature requests](#feature-requests)
12+
* [submitting pull requests](#pull-requests)
13+
14+
Please **do not** use the issue tracker for personal or commercial support requests.
15+
16+
## Bug reports
17+
18+
A bug is either a _demonstrable problem_ that is caused by the code in the repository,
19+
or indicate missing, unclear, or misleading documentation. Good bug reports are extremely
20+
helpful - thank you!
21+
22+
Guidelines for bug reports:
23+
24+
1. **Use the GitHub issue search** &mdash; check if the issue has already been
25+
reported.
26+
27+
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
28+
`master` branch in the repository.
29+
30+
3. **Isolate and report the problem** &mdash; ideally create a reduced test
31+
case.
32+
33+
Please try to be as detailed as possible in your report. Include information about
34+
your Operating System, as well as your `dotnet` (or `mono` \ .Net Framework), F# and project versions. Please provide steps to
35+
reproduce the issue as well as the outcome you were expecting! All these details
36+
will help developers to fix any potential bugs.
37+
38+
Example:
39+
40+
> Short and descriptive example bug report title
41+
>
42+
> A summary of the issue and the environment in which it occurs. If suitable,
43+
> include the steps required to reproduce the bug.
44+
>
45+
> 1. This is the first step
46+
> 2. This is the second step
47+
> 3. Further steps, etc.
48+
>
49+
> `<url>` - a link to the reduced test case (e.g. a GitHub Gist)
50+
>
51+
> Any other information you want to share that is relevant to the issue being
52+
> reported. This might include the lines of code that you have identified as
53+
> causing the bug, and potential solutions (and your opinions on their
54+
> merits).
55+
56+
## Feature requests
57+
58+
Feature requests are welcome and should be discussed on issue tracker. But take a moment to find
59+
out whether your idea fits with the scope and aims of the project. It's up to *you*
60+
to make a strong case to convince the community of the merits of this feature.
61+
Please provide as much detail and context as possible.
62+
63+
64+
## Pull requests
65+
66+
Good pull requests - patches, improvements, new features - are a fantastic
67+
help. They should remain focused in scope and avoid containing unrelated
68+
commits.
69+
70+
**IMPORTANT**: By submitting a patch, you agree that your work will be
71+
licensed under the license used by the project.
72+
73+
If you have any large pull request in mind (e.g. implementing features,
74+
refactoring code, etc), **please ask first** otherwise you risk spending
75+
a lot of time working on something that the project's developers might
76+
not want to merge into the project.
77+
78+
Please adhere to the coding conventions in the project (indentation,
79+
accurate comments, etc.) and don't forget to add your own tests and
80+
documentation. When working with git, we recommend the following process
81+
in order to craft an excellent pull request:
82+
83+
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork,
84+
and configure the remotes:
85+
86+
```bash
87+
# Clone your fork of the repo into the current directory
88+
git clone https://github.com/<your-username>/Waypoint
89+
# Navigate to the newly cloned directory
90+
cd Saturn
91+
# Assign the original repo to a remote called "upstream"
92+
git remote add upstream https://github.com/<project-username>/Waypoint
93+
```
94+
95+
2. If you cloned a while ago, get the latest changes from upstream, and update your fork:
96+
97+
```bash
98+
git checkout master
99+
git pull upstream master
100+
git push
101+
```
102+
103+
3. Create a new topic branch (off of `master`) to contain your feature, change,
104+
or fix.
105+
106+
**IMPORTANT**: Making changes in `master` is discouraged. You should always
107+
keep your local `master` in sync with upstream `master` and make your
108+
changes in topic branches.
109+
110+
```bash
111+
git checkout -b <topic-branch-name>
112+
```
113+
114+
4. Commit your changes in logical chunks. Keep your commit messages organized,
115+
with a short description in the first line and more detailed information on
116+
the following lines. Feel free to use Git's
117+
[interactive rebase](https://help.github.com/articles/about-git-rebase/)
118+
feature to tidy up your commits before making them public.
119+
120+
121+
5. Make sure all the tests are still passing.
122+
123+
```bash
124+
dotnet tool restore
125+
dotnet tool build
126+
```
127+
128+
6. Push your topic branch up to your fork:
129+
130+
```bash
131+
git push origin <topic-branch-name>
132+
```
133+
134+
7. [Open a Pull Request](https://help.github.com/articles/about-pull-requests/)
135+
with a clear title and description.
136+
137+
8. If you haven't updated your pull request for a while, you should consider
138+
rebasing on master and resolving any conflicts.
139+
140+
**IMPORTANT**: _Never ever_ merge upstream `master` into your branches. You
141+
should always `git rebase` on `master` to bring your changes up to date when
142+
necessary.
143+
144+
```bash
145+
git checkout master
146+
git pull upstream master
147+
git checkout <your-topic-branch>
148+
git rebase master
149+
```

‎Content/.config/dotnet-tools.json

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"version": 1,
3+
"isRoot": true,
4+
"tools": {
5+
"fake-cli": {
6+
"version": "5.19.1",
7+
"commands": [
8+
"fake"
9+
]
10+
},
11+
"paket": {
12+
"version": "5.242.2",
13+
"commands": [
14+
"paket"
15+
]
16+
},
17+
"fornax": {
18+
"version": "0.11.0",
19+
"commands": [
20+
"fornax"
21+
]
22+
}
23+
}
24+
}

‎Content/.devcontainer/Dockerfile

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
#-------------------------------------------------------------------------------------------------------------
2+
# Copyright (c) Microsoft Corporation. All rights reserved.
3+
# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
4+
#-------------------------------------------------------------------------------------------------------------
5+
6+
FROM mcr.microsoft.com/dotnet/core/sdk:3.1
7+
8+
# Avoid warnings by switching to noninteractive
9+
ENV DEBIAN_FRONTEND=noninteractive
10+
11+
# This Dockerfile adds a non-root user with sudo access. Use the "remoteUser"
12+
# property in devcontainer.json to use it. On Linux, the container user's GID/UIDs
13+
# will be updated to match your local UID/GID (when using the dockerFile property).
14+
# See https://aka.ms/vscode-remote/containers/non-root-user for details.
15+
ARG USERNAME=vscode
16+
ARG USER_UID=1000
17+
ARG USER_GID=$USER_UID
18+
19+
# Configure apt and install packages
20+
RUN apt-get update \
21+
&& apt-get -y install --no-install-recommends apt-utils dialog 2>&1 \
22+
#
23+
# Verify git, process tools, lsb-release (common in install instructions for CLIs) installed
24+
&& apt-get -y install git openssh-client less iproute2 procps lsb-release \
25+
#
26+
# Create a non-root user to use if preferred - see https://aka.ms/vscode-remote/containers/non-root-user.
27+
&& groupadd --gid $USER_GID $USERNAME \
28+
&& useradd -s /bin/bash --uid $USER_UID --gid $USER_GID -m $USERNAME \
29+
# [Optional] Add sudo support for the non-root user
30+
&& apt-get install -y sudo \
31+
&& echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME\
32+
&& chmod 0440 /etc/sudoers.d/$USERNAME \
33+
#
34+
# Clean up
35+
&& apt-get autoremove -y \
36+
&& apt-get clean -y \
37+
&& rm -rf /var/lib/apt/lists/*
38+
39+
RUN dotnet tool restore
40+
41+
# Switch back to dialog for any ad-hoc use of apt-get
42+
ENV DEBIAN_FRONTEND=dialog

‎Content/.devcontainer/devcontainer.json

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at:
2+
// https://github.com/microsoft/vscode-dev-containers/tree/v0.106.0/containers/dotnetcore-3.1-fsharp
3+
{
4+
"name": "F# (.NET Core 3.1)",
5+
"dockerFile": "Dockerfile",
6+
7+
// Set *default* container specific settings.json values on container create.
8+
//
9+
// .NET Core is now the default for F# in .NET Core 3.0+
10+
// However, .NET Core scripting is not the default yet. Set that to true.
11+
"settings": {
12+
"terminal.integrated.shell.linux": "/bin/bash",
13+
"FSharp.useSdkScripts":true
14+
},
15+
16+
// Add the IDs of extensions you want installed when the container is created.
17+
"extensions": [
18+
"Ionide.Ionide-fsharp",
19+
"ms-vscode.csharp"
20+
]
21+
22+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
23+
// "forwardPorts": [],
24+
25+
// Use 'postCreateCommand' to run commands after the container is created.
26+
// "postCreateCommand": "dotnet restore",
27+
28+
// Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
29+
// "remoteUser": "vscode"
30+
}

‎Content/.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/static/* linguist-documentation

‎Content/.github/ISSUE_TEMPLATE/bug_report.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
### Description
2+
3+
> Short and descriptive example bug report title
4+
> A summary of the issue and the environment in which it occurs. If suitable,
5+
> include the steps required to reproduce the bug.
6+
7+
### Reproduction steps
8+
9+
> 1. This is the first step
10+
> 2. This is the second step
11+
> 3. Further steps, etc.
12+
13+
### Reproduction code
14+
15+
> `<url>` - a link to the reduced test case (e.g. a GitHub Gist)
16+
17+
### Other info
18+
19+
> Any other information you want to share that is relevant to the issue being
20+
> reported. This might include the lines of code that you have identified as
21+
> causing the bug, and potential solutions (and your opinions on their
22+
> merits).

‎Content/.github/ISSUE_TEMPLATE/feature_request.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### Description
2+
3+
> Description of the requested feature
4+
5+
### Potential alternatives
6+
7+
> 1. This is the first step
8+
> 2. This is the second step
9+
> 3. Further steps, etc.
10+
11+
### Other info
12+
13+
> Any other information you want to share that is relevant to the feature request

0 commit comments

Comments
 (0)