Skip to content

Commit 84893bd

Browse files
committed
Merge branch 'master' into lj-separate-health
2 parents 5d1ec5e + 17f0af3 commit 84893bd

32 files changed

+65
-1539
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
contact_links:
22
- name: Help
3-
url: https://github.com/replit/kaboom/discussions/new?category=q-a
3+
url: https://github.com/marklovers/kaplay/discussions/new?category=q-a
44
about: How to use certain Kaboom feature, or how to achieve something with Kaboom
55
- name: Suggestion
6-
url: https://github.com/replit/kaboom/discussions/new?category=ideas
6+
url: https://github.com/replit/kaplay/discussions/new?category=ideas
77
about: Features you'd like Kaboom to have

CONTRIBUTING.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,65 @@
1919
Most kaboom docs are written in `src/types.ts` as [jsDoc](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) above each kaboom component entry.
2020

2121
**Help on improving the documentation is appreciated! Thank you for contributing!**
22+
23+
## Conventional Commits Guide
24+
25+
You must follow the following rules when writing commit messages:
26+
27+
A commit starts with a type, a scope, and a subject:
28+
29+
```
30+
<type>(<scope>): <subject>
31+
```
32+
33+
- The **type** is mandatory. [Should be one of the following](#commit-types).
34+
- We don't use the **scope** right now, you must omit it. This may change in the future.
35+
- The subject must be a short description of the change.
36+
Use the imperative, present tense: "change" not "changed" nor "changes".
37+
38+
### Commit types
39+
40+
`feat`: a new feature or part of a feature
41+
```
42+
feat: add hello() component
43+
```
44+
`fix`: a bug fix
45+
```
46+
fix: fix platformer example
47+
```
48+
`docs`: changes to documentation (jsDoc, md files, etc)
49+
```
50+
docs: update add() component jsDoc example
51+
```
52+
`style`: changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
53+
```
54+
style: format all files
55+
```
56+
`refactor`: a code change that neither fixes a bug nor adds a feature
57+
```
58+
refactor: move assets to src/assets
59+
```
60+
`test`: adding missing tests or correcting existing tests
61+
```
62+
test: added tests for add() component
63+
```
64+
`build`: changes that affect the build system or external dependencies (esbuild, typescript)
65+
```
66+
build: update esbuild to 0.12.0
67+
```
68+
`ci`: changes to our CI configuration files and scripts (Github Actions)
69+
```
70+
ci: add examples test workflow
71+
```
72+
`revert`: reverts a previous commit
73+
```
74+
revert: feat: add hello() component
75+
```
76+
`chore`: updating tasks, general maintenance, etc (anything that doesn't fit in the above types)
77+
```
78+
chore: update README.md
79+
```
80+
`example`: adding a new example
81+
```
82+
example: add firework example
83+
```

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2021 Replit
1+
Copyright (c) 2024 KatTeam and kaplay contributers
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy
44
of this software and associated documentation files (the "Software"), to deal

doc/comp.md

Lines changed: 0 additions & 66 deletions
This file was deleted.

doc/dev.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)