Skip to content
This repository was archived by the owner on Oct 24, 2025. It is now read-only.

Commit f531746

Browse files
committed
feat: initial commit
0 parents  commit f531746

29 files changed

Lines changed: 19946 additions & 0 deletions
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/workflows/pull-request.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Pull request
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
8+
jobs:
9+
lint_commit:
10+
name: Lint commit
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v2
15+
16+
- name: Set up Node.js
17+
uses: actions/setup-node@v2
18+
with:
19+
node-version: '20.9.0'
20+
21+
- name: Install dependencies
22+
run: npm ci
23+
24+
- name: Run commit lint
25+
run: npx commitlint --from="$(git merge-base HEAD origin/${{ github.event.pull_request.base.ref }})"
26+
27+
check_code:
28+
name: Check code
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout code
32+
uses: actions/checkout@v2
33+
34+
- name: Set up PHP
35+
uses: shivammathur/setup-php@v2
36+
with:
37+
php-version: '8.2'
38+
extensions: mbstring, curl
39+
40+
- name: Install Composer
41+
run: |
42+
curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
43+
composer install --ignore-platform-reqs --no-scripts
44+
45+
- name: Run Pint
46+
run: vendor/bin/pint --test
47+
48+
- name: Run PHPStan
49+
run: vendor/bin/phpstan analyse --memory-limit=2G

.github/workflows/release.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths-ignore:
8+
- 'CHANGELOG.md'
9+
10+
jobs:
11+
release:
12+
name: Release
13+
runs-on: ubuntu-latest
14+
permissions:
15+
contents: write
16+
steps:
17+
- name: Checkout repository
18+
uses: actions/checkout@v4
19+
with:
20+
persist-credentials: false
21+
fetch-depth: 0
22+
- name: Generate a token
23+
id: generate-token
24+
uses: tibdex/github-app-token@v2
25+
with:
26+
app_id: ${{ secrets.SEMANTIC_RELEASE_APP_ID }}
27+
private_key: ${{ secrets.SEMANTIC_RELEASE_KEY_PEM }}
28+
- name: Release
29+
uses: cycjimmy/semantic-release-action@v4
30+
id: semantic-release
31+
with:
32+
semantic_version: 22.0.5
33+
extra_plugins: |
34+
@semantic-release/changelog@6.0.3
35+
@semantic-release/git@10.0.1
36+
conventional-changelog-conventionalcommits@7.0.2
37+
env:
38+
GITHUB_TOKEN: ${{ steps.generate-token.outputs.token }}

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
vendor

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v20.9.0

.releaserc.json

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"branches": [
3+
"main"
4+
],
5+
"plugins": [
6+
[
7+
"@semantic-release/commit-analyzer",
8+
{
9+
"preset": "conventionalcommits"
10+
}
11+
],
12+
[
13+
"@semantic-release/release-notes-generator",
14+
{
15+
"preset": "conventionalcommits"
16+
}
17+
],
18+
[
19+
"@semantic-release/github",
20+
{
21+
"successComment": "This ${issue.pull_request ? 'PR is included' : 'issue has been resolved'} in version ${nextRelease.version} :tada:",
22+
"labels": false,
23+
"releasedLabels": false
24+
}
25+
],
26+
[
27+
"@semantic-release/changelog",
28+
{
29+
"changelogFile": "CHANGELOG.md",
30+
"changelogTitle": "# Changelog\n\nAll notable changes to this project will be documented in this file."
31+
}
32+
],
33+
[
34+
"@semantic-release/git",
35+
{
36+
"assets": [
37+
"CHANGELOG.md"
38+
],
39+
"message": "chore(release): version ${nextRelease.version}\n\n${nextRelease.notes}"
40+
}
41+
]
42+
]
43+
}

CODE_OF_CONDUCT.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Code of Conduct
2+
3+
OBMS follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

CONTRIBUTING.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to our project! This guide will help you get started with contributing effectively.
4+
5+
## Code of Conduct
6+
7+
We expect all contributors to follow our Code of Conduct. Please be respectful and constructive in all interactions.
8+
9+
## Getting Started
10+
11+
1. Fork the repository
12+
2. Clone your fork locally
13+
3. Create a new branch for your changes
14+
4. Make your changes
15+
5. Push to your fork
16+
6. Submit a pull request
17+
18+
## Development Process
19+
20+
1. Check existing issues or create a new one to discuss proposed changes
21+
2. Fork the repository and create your branch from `main`
22+
3. Make your changes following our coding standards
23+
4. Add or update tests as needed
24+
5. Update documentation if required
25+
6. Ensure all tests pass locally
26+
7. Submit a pull request
27+
28+
## Commit Guidelines
29+
30+
We follow [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages. This leads to more readable messages that are easy to follow when looking through the project history.
31+
32+
## Pull Request Process
33+
34+
- Ensure your pull request (PR) is focused on a single topic or issue.
35+
- Reference any relevant issues in your PR description (e.g., "Closes #123").
36+
- Provide a clear summary of your changes and the motivation behind them.
37+
- Ensure your code passes all tests and adheres to our coding standards.
38+
- Be responsive to feedback and make requested changes promptly.
39+
- PRs will be reviewed by maintainers and may require approval from multiple reviewers before merging.
40+
41+
## Issue Reporting
42+
43+
- Search existing issues before opening a new one to avoid duplicates.
44+
- Provide a clear and descriptive title.
45+
- Include steps to reproduce, expected behavior, and actual behavior.
46+
- Attach logs, screenshots, or code snippets if helpful.
47+
- Be respectful and constructive in your communication.
48+
49+
## Coding Standards
50+
51+
- Follow the language-specific style guides (e.g., PEP8 for Python, ESLint for JavaScript).
52+
- Write clear, maintainable, and well-documented code.
53+
- Include type annotations and docstrings/comments where appropriate.
54+
- Avoid introducing breaking changes unless discussed and approved.
55+
56+
## Documentation
57+
58+
- Update documentation for any user-facing changes.
59+
- Ensure code examples are up-to-date and accurate.
60+
- Use clear and concise language.
61+
- Follow the existing documentation structure and style.
62+
63+
## Community Support
64+
65+
- Join discussions in our community channels ([GitHub](https://github.com/forepath/obms-module-sdk/discussions) and [Discord](https://discord.gg/5wFMuVvQZM)).
66+
- Help others by answering questions and reviewing PRs.
67+
- Respect differing viewpoints and foster a welcoming environment.
68+
69+
---
70+
71+
Thank you for helping us improve this project! Your contributions make a difference.

0 commit comments

Comments
 (0)