Skip to content

Commit

Permalink
Add repository scaffolding
Browse files Browse the repository at this point in the history
  • Loading branch information
Joannis committed Sep 3, 2023
1 parent 944dfb3 commit 0fe2f27
Show file tree
Hide file tree
Showing 10 changed files with 162 additions and 2 deletions.
17 changes: 17 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing to MongoKitten

We welcome contributions, and request you follow these guidelines.

- [Raising issues](#raising-issues)

## Raising issues

Please raise any bug reports on the issue tracker. Be sure to
search the list to see if your issue has already been raised.

A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong. Provide as much context as possible so we can try to recreate the issue.

## Coding standards
Please note:

- all PRs must have passing builds for all operating systems.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: joannis
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: Joannis

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Environment:**
- OS: [e.g. macOS Sonoma, Linux or Windows]
- Swift Version: [e.g. 5.9]
- BSON Version [e.g. 8.0]

**Additional context**
Add any other context about the problem here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Community Support (Discord)
url: https://discord.gg/H6799jh
about: Meet with the community here!
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea
title: ''
labels: enhancement, help wanted
assignees: Joannis

---

**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.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Question
about: Ask for help
title: ''
labels: help wanted, question
assignees: 'joannis'

---


19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## 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! -->
- [ ] If applicable, I have updated the documentation accordingly.
- [ ] If applicable, I have added tests to cover my changes.
34 changes: 34 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: "CodeQL"

on:
push:
branches: [ "master/7.0" ]
pull_request:
branches: [ "master/7.0" ]

jobs:
analyze:
name: Analyze
runs-on: macos-latest
permissions:
security-events: write

strategy:
fail-fast: false
matrix:
language: [ 'swift' ]

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}

- name: Build
run: swift build

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
28 changes: 28 additions & 0 deletions .github/workflows/swift.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Swift

on:
push:
branches:
- master/7.0
pull_request:
branches:
- master/7.0

jobs:
linux:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
swift-version: ["5.7", "5.8"]
steps:
- name: Check out
uses: actions/checkout@v3

- name: Install Swift
uses: swift-actions/setup-swift@v1
with:
swift-version: ${{ matrix.swift-version }}

- name: Run tests
run: swift test
5 changes: 3 additions & 2 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ let package = Package(
),
.testTarget(
name: "BSONTests",
dependencies: ["BSON"])
],
dependencies: ["BSON"]
)
],
swiftLanguageVersions: [.v4_2]
)

0 comments on commit 0fe2f27

Please sign in to comment.