Skip to content

Commit

Permalink
Merge branch 'master' into lj-separate-health
Browse files Browse the repository at this point in the history
  • Loading branch information
lajbel committed May 23, 2024
2 parents 5d1ec5e + 17f0af3 commit 84893bd
Show file tree
Hide file tree
Showing 32 changed files with 65 additions and 1,539 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
contact_links:
- name: Help
url: https://github.com/replit/kaboom/discussions/new?category=q-a
url: https://github.com/marklovers/kaplay/discussions/new?category=q-a
about: How to use certain Kaboom feature, or how to achieve something with Kaboom
- name: Suggestion
url: https://github.com/replit/kaboom/discussions/new?category=ideas
url: https://github.com/replit/kaplay/discussions/new?category=ideas
about: Features you'd like Kaboom to have
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,65 @@
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.

**Help on improving the documentation is appreciated! Thank you for contributing!**

## Conventional Commits Guide

You must follow the following rules when writing commit messages:

A commit starts with a type, a scope, and a subject:

```
<type>(<scope>): <subject>
```

- The **type** is mandatory. [Should be one of the following](#commit-types).
- We don't use the **scope** right now, you must omit it. This may change in the future.
- The subject must be a short description of the change.
Use the imperative, present tense: "change" not "changed" nor "changes".

### Commit types

`feat`: a new feature or part of a feature
```
feat: add hello() component
```
`fix`: a bug fix
```
fix: fix platformer example
```
`docs`: changes to documentation (jsDoc, md files, etc)
```
docs: update add() component jsDoc example
```
`style`: changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
```
style: format all files
```
`refactor`: a code change that neither fixes a bug nor adds a feature
```
refactor: move assets to src/assets
```
`test`: adding missing tests or correcting existing tests
```
test: added tests for add() component
```
`build`: changes that affect the build system or external dependencies (esbuild, typescript)
```
build: update esbuild to 0.12.0
```
`ci`: changes to our CI configuration files and scripts (Github Actions)
```
ci: add examples test workflow
```
`revert`: reverts a previous commit
```
revert: feat: add hello() component
```
`chore`: updating tasks, general maintenance, etc (anything that doesn't fit in the above types)
```
chore: update README.md
```
`example`: adding a new example
```
example: add firework example
```
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 Replit
Copyright (c) 2024 KatTeam and kaplay contributers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
66 changes: 0 additions & 66 deletions doc/comp.md

This file was deleted.

43 changes: 0 additions & 43 deletions doc/dev.md

This file was deleted.

Loading

0 comments on commit 84893bd

Please sign in to comment.