Skip to content

Commit cb91c03

Browse files
AussieScorcherAussieScorcher
committed
Add initial project structure, including funding, issue templates, and security policy
1 parent 9f7fe2f commit cb91c03

15 files changed

Lines changed: 675 additions & 34 deletions

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
open_collective: stopbars

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: 🐛 Bug report
3+
about: Report a problem or unexpected behavior
4+
title: "[BUG] "
5+
labels: ['bug']
6+
assignees: []
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**How to reproduce**
13+
Steps to reproduce the behavior (e.g.,):
14+
1. Go to '...'
15+
2. Click on '...'
16+
3. Observe that '...' occurs
17+
18+
**Expected behavior**
19+
A clear and concise description of what you expected to happen.
20+
21+
**Screenshots or logs (if applicable)**
22+
If applicable, add screenshots or copy/paste logs to help explain your problem.
23+
24+
**Environment (if relevant)**
25+
- OS / Platform: [e.g. Windows 10, Ubuntu 20.04, macOS 11]
26+
- Version (if applicable): [e.g. 1.2.3]
27+
- Additional info: [e.g. browser, plugin version, external dependency versions]
28+
29+
**Additional context**
30+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: ✨ Feature request
3+
about: Suggest a new feature or enhancement
4+
title: "[FEATURE] "
5+
labels: ['enhancement']
6+
assignees: []
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of the problem that you want to solve (if any).
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen and how it would work.
14+
15+
**Describe alternatives you’ve considered**
16+
Any alternative approaches or solutions you’ve already thought through.
17+
18+
**Additional context**
19+
Add any other context, mockups, or examples about the feature request here.

‎.github/ISSUE_TEMPLATE/task_request.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: ✅ Task / chore
3+
about: A general task or chore (e.g., “update docs,” “refactor code”)
4+
title: "[TASK] "
5+
labels: ['task']
6+
assignees: []
7+
---
8+
9+
**Task overview**
10+
What needs to be done? Briefly describe the scope of the work.
11+
12+
**Why is this task needed?**
13+
Explain why it’s important (e.g., “fixes a bug,” “improves performance,” “updates documentation”).
14+
15+
**Acceptance criteria**
16+
- [ ] Criterion 1
17+
- [ ] Criterion 2
18+
- [ ] Criterion 3 (if any)
19+
20+
**Additional notes**
21+
Anything else a contributor should know (e.g., links to design docs, dependencies, or related issues).

‎.github/workflows/ci.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,51 @@ jobs:
1010
build:
1111
runs-on: ubuntu-latest
1212

13+
outputs:
14+
version-changed: ${{ steps.version-check.outputs.changed }}
15+
version: ${{ steps.version-check.outputs.version }}
16+
1317
steps:
1418
- uses: actions/checkout@v4
19+
with:
20+
fetch-depth: 0
1521

1622
- name: Setup .NET SDK
1723
uses: actions/setup-dotnet@v4
1824
with:
1925
dotnet-version: "9.0.x"
2026

27+
- name: Check version change
28+
id: version-check
29+
run: |
30+
# Get current version from Directory.Build.props
31+
CURRENT_VERSION=$(grep -oP '<Version>\K[^<]+' Directory.Build.props)
32+
echo "Current version: $CURRENT_VERSION"
33+
echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
34+
35+
# Check if this is the first commit or if version changed
36+
if git rev-parse HEAD~1 >/dev/null 2>&1; then
37+
git checkout HEAD~1 -- Directory.Build.props 2>/dev/null || echo "No previous version of Directory.Build.props"
38+
if [ -f Directory.Build.props ]; then
39+
PREVIOUS_VERSION=$(grep -oP '<Version>\K[^<]+' Directory.Build.props)
40+
echo "Previous version: $PREVIOUS_VERSION"
41+
if [ "$CURRENT_VERSION" != "$PREVIOUS_VERSION" ]; then
42+
echo "Version changed from $PREVIOUS_VERSION to $CURRENT_VERSION"
43+
echo "changed=true" >> $GITHUB_OUTPUT
44+
else
45+
echo "Version unchanged"
46+
echo "changed=false" >> $GITHUB_OUTPUT
47+
fi
48+
else
49+
echo "No previous Directory.Build.props found, treating as version change"
50+
echo "changed=true" >> $GITHUB_OUTPUT
51+
fi
52+
git checkout HEAD -- Directory.Build.props
53+
else
54+
echo "First commit, treating as version change"
55+
echo "changed=true" >> $GITHUB_OUTPUT
56+
fi
57+
2158
- name: Restore dependencies
2259
run: dotnet restore
2360

@@ -32,3 +69,28 @@ jobs:
3269
with:
3370
name: simconnectnet-packages
3471
path: ./artifacts/*.nupkg
72+
73+
deploy:
74+
needs: build
75+
runs-on: ubuntu-latest
76+
if: github.event_name == 'push' && github.ref == 'refs/heads/main' && needs.build.outputs.version-changed == 'true'
77+
78+
steps:
79+
- name: Download package artifacts
80+
uses: actions/download-artifact@v4
81+
with:
82+
name: simconnectnet-packages
83+
path: ./artifacts
84+
85+
- name: Setup .NET SDK
86+
uses: actions/setup-dotnet@v4
87+
with:
88+
dotnet-version: "9.0.x"
89+
90+
- name: Push to NuGet
91+
run: |
92+
echo "Deploying version ${{ needs.build.outputs.version }} to NuGet"
93+
dotnet nuget push ./artifacts/*.nupkg \
94+
--api-key ${{ secrets.NUGET_PUSH_KEY }} \
95+
--source https://api.nuget.org/v3/index.json \
96+
--skip-duplicate

‎CHANGELOG.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
## [0.1.0-beta] - 2025-08-07
11+
12+
### Added
13+
14+
- Initial beta release of SimConnect.NET
15+
- SimConnectClient with async/await patterns and background message processing
16+
- SimVarManager for dynamic SimVar operations with automatic data definition caching
17+
- SimVarRegistry system for predefined SimVars with type validation
18+
- AircraftDataManager for high-level aircraft data aggregation (uses concurrent requests for efficiency)
19+
- SimObjectManager for AI object creation and lifecycle management
20+
- InputEventManager for input event handling and controller enumeration
21+
- InputGroupManager for organizing and prioritizing input events
22+
- Auto-reconnection capabilities with configurable attempts and delays
23+
- Connection health monitoring and status events
24+
- Comprehensive facility data support (airports, VOR/NDB stations, waypoints, jetways)
25+
- Extensive enum definitions for navigation aids, airports, and flight planning
26+
- Comprehensive P/Invoke bindings for SimConnect SDK with ANSI marshaling
27+
- Multi-targeting support for .NET 8.0 and 9.0
28+
- NuGet package configuration with symbol packages
29+
- Automated CI/CD pipeline with version detection and NuGet deployment
30+
31+
### Security
32+
33+
- ANSI string marshaling for safe P/Invoke operations
34+
- Proper disposal patterns for unmanaged resources
35+
- Thread-safe concurrent collections for request handling

‎CODE_OF_CONDUCT.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
BARS.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

0 commit comments

Comments
 (0)