JoshHiles · JoshHiles · Jul 22, 2021 · Jul 22, 2021 · Jul 22, 2021 · Jul 23, 2021
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[Bug] Lorem Ipsum"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Please point us to a minimalistic repro project hosted in a GitHub repo.
+For a repo project, create a new project using the template of your your choice, apply the minimum required code to result in the issue you're observing.
+
+We will close this issue if:
+- the repro project you share with us is complex
+- if we will not be able to reproduce the behavior you're reporting
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+### Exceptions (if any)
+Include the exception you get when facing this issue
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+### Further technical details
+- Scientist.net version
+- Include the output of `dotnet --info`
+- The IDE (VS / VS Code/ VS4Mac) you're running on, and its version
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[Feature] Lorem Ipsum"
+labels: feature
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,31 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Related Issue
+<!--- This project only accepts pull requests related to open issues -->
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] Documentation
+
+## Checklist: 
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] I have read the **[CONTRIBUTING](../../Contributing.md)** document.
+- [ ] I have checked to ensure there aren't other open **[PULL REQUESTS](../../../pulls)** for the same update/change.
+- [ ] My code follows the code style of this project.
+- [ ] I have updated the documentation accordingly where applicable.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.
+- [ ] Coverage is 100% for new code.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "nuget"
+    directory: "/"
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -0,0 +1,47 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [3.0.0]
+  pull_request:
+    branches: [3.0.0]
+  schedule:
+    - cron: "0 0 * * 1"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["csharp"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+
+      - uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 8.x
+          cache: true
+          cache-dependency-path: "**/packages.lock.json"
+
+      - run: dotnet restore --locked-mode
+
+      - run: |
+          dotnet build /p:UseSharedCompilation=false
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml
@@ -0,0 +1,31 @@
+name: Unit test
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [3.0.0]
+  pull_request:
+    branches: [3.0.0]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 8.x
+          cache: true
+          cache-dependency-path: "**/packages.lock.json"
+
+      - name: Restore dependencies
+        run: dotnet restore --locked-mode
+
+      - name: Build
+        run: dotnet build --no-restore
+
+      - name: Test
+        run: dotnet test --no-build --verbosity normal /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
diff --git a/.gitignore b/.gitignore
@@ -126,3 +126,6 @@ artifacts/
 *.scc
 
 BenchmarkDotNet.Artifacts
+
+**/.vs
+/Scientist.Test/coverage.json
diff --git a/CodeOfConduct.md b/CodeOfConduct.md
@@ -0,0 +1,120 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement on [Gitter](https://gitter.im/scientistproject/community).
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
diff --git a/Contributing.md b/Contributing.md
@@ -0,0 +1,87 @@
+# Contributing to Scientist.NET
+
+## Table of Contents:
+- [Code of Conduct](#code-of-conduct)
+- [I just have a question](#i-just-have-a-question)
+- [How can i contribute?](#how-can-i-contribute)
+  - [Reporting bugs](#reporting-bugs)
+  - [Suggesting enhancements](#suggesting-enhancements)
+  - [Your first code contribution](#your-first-code-contribution)
+  - [Pull Requests](#pull-requests)
+- [Styleguides](#styleguides)
+  - [Git Commit Messages](#git-commit-messages)
+- [Labels](#labels)
+  - [Issue labels](#issue-labels)
+  - [Topic category labels](#topic-category-labels)
+  - [Pull request labels](#pull-request-labels)
+
+## Code of conduct
+
+This project and everyone participating in it is governed by the [Code of Conduct](CodeOfConduct.md). By participating, you are expected to uphold this code.
+
+Please report unacceptable behavior on [Gitter](https://gitter.im/scientistproject/community) to a maintainer.
+
+## I just have a question
+
+> Please don't file an issue to ask a question.
+
+> TODO
+
+
+## How can i contribute?
+
+### Reporting bugs
+
+> TODO
+
+
+### Suggesting enhancements
+
+> TODO
+
+### Your first code contribution
+- [good first issue](https://github.com/scientistproject/Scientist.net/issues?q=is:issue+is:open+label:good+first+issue)
+
+### Pull Requests
+
+Please follow these steps to have your contribution considered by the maintainers:
+
+- Follow all instructions in [the template](.github/PULL_REQUEST_TEMPLATE/pull_request_template.md)
+- Follow the [styleguides](#styleguides)
+- After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing<details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>
+
+While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
+
+## Styleguides
+### Git commit messages
+Please refer to [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+
+| Type | Usage | Version increment |
+| --- | --- | --- |
+| fix(): | A commit which fixes or patches a bug | x.x.1|
+| feat(): | A commit which introduces a new feature | x.1.x|
+| BREAKING CHANGE: | A commit which has BREAKING CHANGE: in the footer | 1.x.x |
+
+## Labels
+
+### Issue labels
+| Label name | Search | Description |
+| --- | --- | --- |
+| `good first issue` | [search](https://github.com/scientistproject/Scientist.net/issues?q=is:issue+is:open+label:good+first+issue) | Less complex issues which would be good first issues to work on for users who want to contribute. |
+| `help wanted` | [search](https://github.com/scientistproject/Scientist.net/issues?q=is:issue+is:open+label:help+wanted) | The would appreciate help from the community in resolving these issues. |
+
+### Topic category labels
+| Label name | Search | Description |
+| --- | --- | --- |
+| `documentation` | [search](https://github.com/scientistproject/Scientist.net/issues?q=is:issue+is:open+label:) | Related to any type of documentation. |
+| `performance` | [search](https://github.com/scientistproject/Scientist.net/issues?q=is:issue+is:open+label:performance) | Related to performance. |
+| `security` | [search](https://github.com/scientistproject/Scientist.net/issues?q=is:issue+is:open+label:security) | Related to security. |
+
+### Pull request labels
+| Label name | Search | Description |
+| --- | --- | --- |
+| `work-in-progress` | [search](https://github.com/scientistproject/Scientist.net/issues?q=is:issue+is:open+label:work-in-progress) | Pull requests which are still being worked on, more changes will follow. |
+| `needs-review` | [search](https://github.com/scientistproject/Scientist.net/issues?q=is:issue+is:open+label:needs-review) | Pull requests which need code review, and approval from maintainers. |
+| `under-review` | [search](https://github.com/scientistproject/Scientist.net/issues?q=is:issue+is:open+label:under-review) | Pull requests being reviewed by maintainers. |
+| `requires-changes` | [search](https://github.com/scientistproject/Scientist.net/issues?q=is:issue+is:open+label:requires-changes) | Pull requests which need to be updated based on review comments and then reviewed again. |
+| `needs-testing` | [search](https://github.com/scientistproject/Scientist.net/issues?q=is:issue+is:open+label:needs-testing) | Pull requests which need manual testing. |
-Original file line number
+Diff line change
@@ Expand Up / @@ -126,3 +126,6 @@ artifacts/ @@
     *.scc
     BenchmarkDotNet.Artifacts
+    **/.vs
+    /Scientist.Test/coverage.json