Skip to content

Commit

Permalink
✨ feat: Introduce configuration files for project setup
Browse files Browse the repository at this point in the history
Add various configuration files necessary for project setup, including
linting, formatting, commit conventions, CI/CD workflows, and more.

Changes include:
- Configuration files for editor settings, linting, and code formatting.
- Issue and pull request templates for GitHub.
- Workflow files for automated issue management and CI/CD pipelines.
- Husky hooks for commit message linting and pre-commit checks.
- Renovate configuration for dependency management.
- TypeScript configuration adjustments for improved type-checking.

These changes establish a standardized development environment and
automate various aspects of the development workflow, ensuring consistency
and quality across the project.
  • Loading branch information
Gincioks committed May 4, 2024
1 parent bc9be11 commit 124a049
Show file tree
Hide file tree
Showing 34 changed files with 544 additions and 233 deletions.
3 changes: 3 additions & 0 deletions .bunfig.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[install.lockfile]

save = false
1 change: 1 addition & 0 deletions .changelogrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('@arietta-studio/lint').changelog;
1 change: 1 addition & 0 deletions .commitlintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('@arietta-studio/lint').commitlint;
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# http://editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('@arietta-studio/lint').eslint;
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: '🐛 Bug Report'
description: 'Report an bug'
title: '[Bug] '
labels: ['🐛 Bug']
body:
- type: dropdown
attributes:
label: '💻 Operating System'
options:
- Android
- iOS
validations:
required: true
- type: dropdown
attributes:
label: '🌐 Browser'
options:
- Chrome
- Edge
- Safari
- Firefox
- Other
validations:
required: true
- type: textarea
attributes:
label: '🐛 Bug Description'
description: A clear and concise description of the bug.
validations:
required: true
- type: textarea
attributes:
label: '🚦 Expected Behavior'
description: A clear and concise description of what you expected to happen.
- type: textarea
attributes:
label: '📷 Recurrence Steps'
description: A clear and concise description of how to recurrence.
- type: textarea
attributes:
label: '📝 Additional Information'
description: If your problem needs further explanation, or if the issue you're seeing cannot be reproduced in a gist, please add more information here.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: '🌠 Feature Request'
description: 'Suggest an idea'
title: '[Request] '
labels: ['🌠 Feature Request']
body:
- type: textarea
attributes:
label: '🥰 Feature Description'
description: Please add a clear and concise description of the problem you are seeking to solve with this feature request.
validations:
required: true
- type: textarea
attributes:
label: '🧐 Proposed Solution'
description: Describe the solution you'd like in a clear and concise manner.
validations:
required: true
- type: textarea
attributes:
label: '📝 Additional Information'
description: Add any other context about the problem here.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/3_question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: '😇 Help Wanted'
description: 'Need help'
title: '[Question] '
labels: ['😇 Help Wanted']
body:
- type: textarea
attributes:
label: '🧐 Proposed Solution'
description: A clear and concise description of the proplem.
validations:
required: true
- type: textarea
attributes:
label: '📝 Additional Information'
description: Add any other context about the problem here.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/4_other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: '📝 Other'
about: 'Other issues'
title: ''
labels: ''
assignees: ''
---
82 changes: 0 additions & 82 deletions .github/ISSUE_TEMPLATE/bug.yaml

This file was deleted.

32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/documentation.yaml

This file was deleted.

40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/feature.yaml

This file was deleted.

18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#### 💻 Change Type

<!-- For change type, change [ ] to [x]. -->

- [ ] ✨ feat
- [ ] 🐛 fix
- [ ] ♻️ refactor
- [ ] 💄 style
- [ ] 🔨 chore
- [ ] 📝 docs

#### 🔀 Description of Change

<!-- Thank you for your Pull Request. Please provide a description above. -->

#### 📝 Additional Information

<!-- Add any other context about the Pull Request here. -->
67 changes: 67 additions & 0 deletions .github/workflows/issue-auto-comments.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Issue Auto Comment
on:
issues:
types:
- opened
- closed
- assigned
pull_request_target:
types:
- opened
- closed

permissions:
contents: read

jobs:
run:
permissions:
issues: write # for actions-cool/issues-helper to update issues
pull-requests: write # for actions-cool/issues-helper to update PRs
runs-on: ubuntu-latest
steps:
- name: Auto Comment on Issues Opened
uses: wow-actions/auto-comment@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN}}
issuesOpened: |
👀 @{{ author }}
Thank you for raising an issue. We will investigate into the matter and get back to you as soon as possible.
Please make sure you have given us as much context as possible.
- name: Auto Comment on Issues Closed
uses: wow-actions/auto-comment@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN}}
issuesClosed: |
✅ @{{ author }}
<br/>
This issue is closed, If you have any questions, you can comment and reply.
- name: Auto Comment on Pull Request Opened
uses: wow-actions/auto-comment@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN}}
pullRequestOpened: |
👍 @{{ author }}
<br>
Thank you for raising your pull request and contributing to our Community
Please make sure you have followed our contributing guidelines. We will review it as soon as possible.
If you encounter any problems, please feel free to connect with us.
- name: Auto Comment on Pull Request Merged
uses: actions-cool/pr-welcome@main
if: github.event.pull_request.merged == true
with:
token: ${{ secrets.GITHUB_TOKEN }}
comment: |
❤️ Great PR @${{ github.event.pull_request.user.login }} ❤️
<br>
The growth of project is inseparable from user feedback and contribution, thanks for your contribution!
emoji: 'hooray'
pr-emoji: '+1, heart'
- name: Remove inactive
if: github.event.issue.state == 'open' && github.actor == github.event.issue.user.login
uses: actions-cool/issues-helper@v3
with:
actions: 'remove-labels'
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: ${{ github.event.issue.number }}
labels: 'Inactive'
23 changes: 23 additions & 0 deletions .github/workflows/issue-check-inactive.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Issue Check Inactive

on:
schedule:
- cron: '0 0 */15 * *'

permissions:
contents: read

jobs:
issue-check-inactive:
permissions:
issues: write # for actions-cool/issues-helper to update issues
pull-requests: write # for actions-cool/issues-helper to update PRs
runs-on: ubuntu-latest
steps:
- name: check-inactive
uses: actions-cool/issues-helper@v3
with:
actions: 'check-inactive'
token: ${{ secrets.GITHUB_TOKEN }}
inactive-label: 'Inactive'
inactive-day: 30
Loading

0 comments on commit 124a049

Please sign in to comment.