Skip to content

Commit

Permalink
chore: add pr template and adjust ci gha (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
dbeilin authored Dec 29, 2024
2 parents a7c4d30 + fc15e70 commit ea0c118
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
54 changes: 54 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Description

<!-- Please include a summary of the changes -->

## Type of change

<!-- Please delete options that are not relevant and title your PR accordingly -->

- `feat: ` Add a new feature (minor version bump)
> Example: feat: add user authentication system
- `fix: ` Fix a bug (patch version bump)
> Example: fix: resolve memory leak in data processing
- `perf: ` Performance improvement (patch version bump)
> Example: perf: optimize database queries
- `docs: ` Documentation only changes
> Example: docs: update API documentation
- `style: ` Changes that do not affect the meaning of the code
> Example: style: fix code formatting
- `refactor: ` Code changes that neither fix a bug nor add a feature
> Example: refactor: restructure authentication logic
- `test: ` Adding missing tests or correcting existing tests
> Example: test: add unit tests for user service
- `chore: ` Changes to build process or auxiliary tools
> Example: chore: update dependencies
- `revert: ` Revert a previous commit
> Example: revert: remove feature X
- `ci: ` Changes to CI configuration files and scripts
> Example: ci: add new deployment workflow
- `build: ` Changes that affect the build system
> Example: build: update vite configuration
### Breaking Changes

<!-- For breaking changes, add ! after the type -->
- Add ! after any type to indicate a BREAKING CHANGE (major version bump)
> Example: feat!: redesign API endpoints
> Example: fix!: drop support for older browsers
## Checklist

- [ ] I have titled my PR using the correct semantic prefix
- [ ] I have tested these changes
- [ ] I have updated the documentation accordingly
- [ ] My changes generate no new warnings
6 changes: 6 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ on:
pull_request:
branches:
- main
paths-ignore:
- '**.md'
- '.github/**'
- '.gitignore'
- '.dockerignore'
- '.vscode/**'

jobs:
build:
Expand Down

0 comments on commit ea0c118

Please sign in to comment.