Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
name: Bug Report
Comment thread
coderabbitai[bot] marked this conversation as resolved.
description: Report a bug to help us improve
type: bug
body:
- type: dropdown
id: priority
attributes:
label: Priority
description: How critical is this bug?
options:
- P0 (Critical — pick up ASAP)
- P1 (High)
- P2 (Medium)
- P3 (Low)
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the bug.
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Walk us through how to reproduce the bug step by step.
value: |
1.
2.
3.
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: What did you expect to happen?
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
description: What actually happened?
validations:
required: true

- type: upload
id: screenshots
attributes:
label: Screenshots
description: >-
If applicable, upload screenshots to help
explain the problem.
validations:
Comment thread
coderabbitai[bot] marked this conversation as resolved.
required: false

- type: input
id: os
attributes:
label: Operating System
placeholder: "e.g., macOS 15, Windows 11, Ubuntu 24.04"
validations:
required: false

- type: input
id: version
attributes:
label: Version / Commit
placeholder: "e.g., v1.2.3 or commit SHA"
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context about the problem here.
validations:
required: false
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
blank_issues_enabled: true
Comment thread
coderabbitai[bot] marked this conversation as resolved.
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
name: Feature Request
Comment thread
coderabbitai[bot] marked this conversation as resolved.
description: Suggest an idea or improvement
type: feature
body:
- type: dropdown
id: size
attributes:
label: Size
description: Estimated effort for this feature.
options:
- "Size:0"
- "Size:1"
- "Size:2"
- "Size:3"
- "Size:5"
- "Size:8"
- "Size:13"
- "Size:20"
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: >-
A clear and concise description of the
feature or improvement you'd like.
validations:
required: true

- type: textarea
id: use-case
attributes:
label: Use Case
description: >-
Describe the problem or workflow this
feature would address. Why is it needed?
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: Proposed Solution
description: >-
A clear and concise description of how
you'd like this to work.
validations:
required: false

- type: textarea
id: alternatives-considered
attributes:
label: Alternatives Considered
description: >-
Describe any alternative solutions or
workarounds you've considered.
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: >-
Add any other context, mockups, or references
about the feature request here.
validations:
required: false
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Task
description: General work or technical debt
type: task
body:
- type: textarea
id: description
attributes:
label: Description
description: What needs to be done and why?
validations:
required: true

- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
description: How do we know this task is complete?
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, references, or related issues here.
validations:
required: false
Comment thread
coderabbitai[bot] marked this conversation as resolved.
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Description

<!-- Briefly describe what this pull request does and why. -->

## Related Issue

<!-- Link the related issue, e.g. Closes #123 -->

## Changes

<!-- List the key changes introduced by this PR. -->

-

## Checklist

- [ ] My code follows the project's coding conventions
- [ ] I have tested my changes locally
- [ ] I have added or updated tests where applicable
- [ ] I have updated documentation where applicable
- [ ] My changes do not introduce new warnings or errors
Comment thread
jasperdemmers marked this conversation as resolved.
31 changes: 31 additions & 0 deletions .github/workflows/ci-analyze.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: CI / Analyze
Comment thread
jasperdemmers marked this conversation as resolved.
run-name: CI | Analyze

concurrency:
group: ${{ github.workflow_ref }}-${{ github.ref }}
cancel-in-progress: true

"on":
pull_request:
branches:
- main

jobs:
analyze:
name: Analyze
runs-on: simplepark-runners

steps:
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: '3.12'

- name: Install yamllint
run: pip install yamllint

- name: Lint YAML
run: yamllint --strict .
27 changes: 27 additions & 0 deletions .github/workflows/ci-format.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: CI / Format
run-name: CI | Format

concurrency:
group: ${{ github.workflow_ref }}-${{ github.ref }}
cancel-in-progress: true

"on":
pull_request:
branches:
- main

jobs:
format:
name: Format
runs-on: simplepark-runners

steps:
- uses: actions/checkout@v4

- name: Lint Markdown
uses: DavidAnson/markdownlint-cli2-action@v22
Comment thread
jasperdemmers marked this conversation as resolved.
with:
globs: |
**/*.md
!**/node_modules/**
26 changes: 26 additions & 0 deletions .github/workflows/ci-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: CI / Test
run-name: CI | Test

concurrency:
group: ${{ github.workflow_ref }}-${{ github.ref }}
cancel-in-progress: true

"on":
pull_request:
branches:
- main

jobs:
test:
name: Test
runs-on: simplepark-runners

steps:
- uses: actions/checkout@v4

- name: No tests yet
run: >-
echo "No automated tests are defined yet.
This job exists to satisfy branch
protection requirements."
11 changes: 11 additions & 0 deletions .markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"config": {
"default": true,
"MD013": false, // Disable line length check (80 chars is too restrictive for tables and URLs)
"MD033": false, // Allow inline HTML (needed for MkDocs card grids etc.)
"MD041": false // Allow files to start without H1 (metadata titles, READMEs)
},
"globs": [
"**/*.md",
]
}
47 changes: 47 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# SimplePark Code of Conduct

## Purpose

This Code of Conduct defines expected behavior and responsibilities for contributing to and participating in SimplePark communities. It exists to foster an open, welcoming, and respectful environment where everyone can participate constructively.

This Code of Conduct applies to all community interactions related to SimplePark, including GitHub repositories, issues, pull requests, discussions, and any other communication channels managed by SimplePark.

## Expected Behavior

Participants are expected to contribute in a harassment-free environment for everyone, regardless of gender, sexual identity and orientation, religion, disability, ethnicity, socioeconomic status, nationality, age, level of experience, or education.

Examples of behavior that contributes to a positive environment:

- Being welcoming, friendly, and inclusive
- Acting with consideration, modesty, and respect
- Giving and accepting constructive criticism gracefully
- Respecting different viewpoints and experiences
- Encouraging collaboration
- Showing empathy towards other community members
- Using polite and inclusive language

## Unacceptable Behavior

The following behavior will not be tolerated:

- Intimidation or threats directed at other individuals
- Political or personal attacks
- Publishing private information without explicit permission (e.g., physical address, email)
- Trolling or deliberately disruptive behavior
- Use of sexualized language or imagery
- Insulting, derogatory, harmful, or prejudicial comments
- Harassment of any kind, whether public or private

## Responsibilities

By contributing to or participating in SimplePark-managed communities, all individuals are expected to comply with this Code of Conduct.

SimplePark is responsible for clarifying the standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that violates this Code of Conduct. This includes the right to reject, edit, or remove contributions (such as comments, commits, issues, and discussion entries) and to temporarily or permanently ban any participant whose behavior is deemed inappropriate, threatening, offensive, or harmful.

## Enforcement

Instances of unacceptable behavior may be reported by contacting SimplePark at [info@simplepark.nl](mailto:info@simplepark.nl). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Confidentiality with regard to the reporter will be maintained at all times.
Comment thread
jasperdemmers marked this conversation as resolved.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1, and inspired by the Mercedes-Benz FOSS Code of Conduct.
Comment thread
jasperdemmers marked this conversation as resolved.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing to SimplePark

Thank you for your interest in contributing to SimplePark. Please note that SimplePark is primarily a closed-source company. These guidelines apply to any public repositories we maintain.
Comment thread
jasperdemmers marked this conversation as resolved.

## Code of Conduct

All contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it before participating.

## Contributor License Agreement

Before we can accept your contribution, you must sign our [Contributor License Agreement](CONTRIBUTORS_LICENSE_AGREEMENT.md). This ensures that SimplePark B.V. has the necessary rights to use and distribute your contributions.

## How to Contribute

### Reporting Issues

- Use the repository's issue tracker to report bugs or suggest features.
- Check existing issues before creating a new one to avoid duplicates.
- Provide as much detail as possible: steps to reproduce, expected behavior, actual behavior, and your environment.

### Submitting Changes

1. Fork the repository and create your branch from `main`.
2. Follow the project's coding style and conventions (see [Project Conventions](PROJECT_CONVENTIONS.md)).
3. Write clear, descriptive commit messages following the [Conventional Commits](https://www.conventionalcommits.org/) specification.
4. Ensure your changes pass any existing tests and linting rules.
5. Open a pull request with a clear description of what you changed and why.

### Pull Request Guidelines

- Keep pull requests focused on a single change.
- Reference any related issues in the pull request description.
- Be responsive to review feedback.
- All pull requests require at least one approving review before merging.

## Questions?

If you have questions about contributing, reach out at [info@simplepark.nl](mailto:info@simplepark.nl).
Loading
Loading