Skip to content

Commit 92e1e13

Browse files
committed
feat: adding csml project template
1 parent 6226177 commit 92e1e13

5 files changed

Lines changed: 97 additions & 1 deletion

File tree

.github/pull_request_template.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Pull Request
2+
3+
<!--
4+
Please make sure to have read the CONTRIBUTING.md guidelines.
5+
-->
6+
7+
## Description
8+
9+
<!--
10+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
11+
12+
Fixes # (issue)
13+
-->
14+
15+
## Type of change
16+
17+
<!--
18+
Please delete options that are not relevant.
19+
-->
20+
21+
- [ ] Bug fix (non-breaking change which fixes an issue)
22+
- [ ] New feature (non-breaking change which adds functionality)
23+
- [ ] Documentation update
24+
- [ ] Code style update
25+
- [ ] Refactoring

.github/workflows/build.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Build
2+
on:
3+
push:
4+
branches: ["develop"]
5+
pull_request:
6+
branches: ["develop"]
7+
jobs:
8+
Build:
9+
if: github.repository == 'YourRepositoryNameHere'
10+
name: Build
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: read
14+
checks: write
15+
pull-requests: write
16+
steps:
17+
- name: Check out the repo
18+
uses: actions/checkout@v4
19+
20+
- name: Perform commit linting
21+
uses: wagoid/commitlint-github-action@v6

ATTRIBUTIONS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Dependencies
2+
3+
This project makes use of the following dependencies:
4+
5+
| Dependency Name | Website | License | License Text URL |
6+
| --------------- | ------- | ------- | ---------------- |
7+
| | | | |

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,16 @@
1-
# Template-CSML
1+
# Project Template
2+
3+
Template repository for initializing new GitHub projects within the organization.
4+
5+
## Module Structure
6+
7+
- `*/` - Each application's source (e.g., pingPong).
8+
9+
Continuous integration is enforced via GitHub Actions. Push and pull request events trigger automated formatting
10+
checks.
11+
12+
## Contributing
13+
14+
Refer to [CONTRIBUTING.md](https://github.com/CollaborativeStateMachines/.github/blob/main/CONTRIBUTING.md) for strict
15+
organizational guidelines regarding code style, commit
16+
conventions, and the review process.

pingPong/main.pkl

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
amends "https://raw.githubusercontent.com/CollaborativeStateMachines/Cirrina/refs/heads/develop/src/main/resources/pkl/csm/csml.pkl"
2+
3+
collaborativeStateMachine {
4+
stateMachines {
5+
["ping"] {
6+
states {
7+
["ping"] = new Initial {
8+
entry {
9+
new Emit { event { topic = "ping" } }
10+
new Ctr { counter = "ping.count" }
11+
}
12+
on { ["pong"] { to = "ping" } }
13+
}
14+
}
15+
}
16+
["pong"] = new StateMachine {
17+
states {
18+
["pong"] = new Initial {
19+
on { ["ping"] { yields { new Emit { event { topic = "pong" } } } } }
20+
}
21+
}
22+
}
23+
}
24+
}
25+
instances {
26+
["ping"] { stateMachineName = "ping" }
27+
["pong"] { stateMachineName = "pong" }
28+
}

0 commit comments

Comments
 (0)