Skip to content

Commit

Permalink
docs: update github files
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoRCD committed Mar 31, 2024
1 parent 75d2cb0 commit 9af5353
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 13 deletions.
32 changes: 21 additions & 11 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,32 @@
<!---
☝️ PR title should follow conventional commits (https://conventionalcommits.org)
Here are the available types:
- breaking (fix or feature that would cause existing functionality to change) 💥
- feat (a non-breaking change that adds functionality) ✨
- fix (a non-breaking change that fixes an issue) 🐞
- build (changes that affect the build system or external dependencies) 🏗
- ci (changes to our CI configuration files and scripts) 🚀
- docs (updates to the documentation or readme) 📖
- enhancement (improving an existing functionality) 🌈
- chore (updates to the build process or auxiliary tools and libraries) 📦
- perf (a code change that improves performance) ⚡️
- style (changes that do not affect the meaning of the code) 💅
- tests (adding or updating tests) 🧪
- refactor (a code change that neither fixes a bug nor adds a feature) 🛠
- revert (reverts a previous commit) 🔄
we can also use the following scopes:
- app
- cli
- docs
-->

### 🔗 Linked issue

<!-- If it resolves an open issue, please link the issue here. For example "Resolves #123" -->

### ❓ Type of change

<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->

- [ ] 📖 Documentation (updates to the documentation or readme)
- [ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
- [ ] 👌 Enhancement (improving an existing functionality)
- [ ] ✨ New feature (a non-breaking change that adds functionality)
- [ ] 🧹 Chore (updates to the build process or auxiliary tools and libraries)
- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

### 📚 Description

<!-- Describe your changes in detail -->
Expand Down
46 changes: 46 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
changelog:
exclude:
labels:
- ignore-for-release
authors:
- octocat
categories:
- title: Breaking Changes 💥
labels:
- breaking
- title: Features 🚀
labels:
- feat
- title: Bug Fixes 🐞
labels:
- fix
- title: Build System 🛠
labels:
- build
- title: Continuous Integration 🔄
labels:
- ci
- title: Documentation 📚
labels:
- docs
- title: Enhancements 🌈
labels:
- enhancement
- title: Dependency Updates 📦
labels:
- chore
- title: Performance Improvements ⚡️
labels:
- performance
- title: Style 💅
labels:
- style
- title: Tests 🧪
labels:
- tests
- title: Refactoring 🛠
labels:
- refactor
- title: Revert 🔄
labels:
- revert
8 changes: 6 additions & 2 deletions .github/workflows/semantic-pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,16 @@ jobs:
breaking
feat
fix
build
ci
docs
enhancement
chore
performance
style
tests
refactor
revert
style
test
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Expand Down

0 comments on commit 9af5353

Please sign in to comment.