Skip to content

Commit

Permalink
chore: add github files for actions
Browse files Browse the repository at this point in the history
  • Loading branch information
YisusChrist committed Aug 10, 2024
1 parent e0baf1c commit 7602e42
Show file tree
Hide file tree
Showing 14 changed files with 605 additions and 212 deletions.
20 changes: 10 additions & 10 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
- The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand Down
106 changes: 53 additions & 53 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,74 +127,74 @@ to allow this:
type(scope)!: subject
```

- `type`: the type of the commit is one of the following:

- `feat`: new features.
- `fix`: bug fixes.
- `docs`: documentation changes.
- `refactor`: refactor of a particular code section without introducing
new features or bug fixes.
- `style`: code style improvements.
- `perf`: performance improvements.
- `test`: changes to the test suite.
- `ci`: changes to the CI system.
- `build`: changes to the build system (we don't yet have one so this shouldn't apply).
- `chore`: for other changes that don't match previous types. This doesn't appear
in the changelog.

- `scope`: section of the codebase that the commit makes changes to. If it makes changes to
many sections, or if no section in particular is modified, leave blank without the parentheses.
Examples:

- Commit that changes the `git` plugin:
- `type`: the type of the commit is one of the following:

```
feat(git): add alias for `git commit`
```
- `feat`: new features.
- `fix`: bug fixes.
- `docs`: documentation changes.
- `refactor`: refactor of a particular code section without introducing
new features or bug fixes.
- `style`: code style improvements.
- `perf`: performance improvements.
- `test`: changes to the test suite.
- `ci`: changes to the CI system.
- `build`: changes to the build system (we don't yet have one so this shouldn't apply).
- `chore`: for other changes that don't match previous types. This doesn't appear
in the changelog.

- Commit that changes many plugins:
- `scope`: section of the codebase that the commit makes changes to. If it makes changes to
many sections, or if no section in particular is modified, leave blank without the parentheses.
Examples:

```
style: fix inline declaration of arrays
```
- Commit that changes the `git` plugin:

- `!`: this goes after the `scope` (or the `type` if scope is empty), to indicate that the commit
introduces breaking changes.
```
feat(git): add alias for `git commit`
```

Optionally, you can specify a message that the changelog tool will display to the user to indicate
what's changed and what they can do to deal with it. You can use multiple lines to type this message;
the changelog parser will keep reading until the end of the commit message or until it finds an empty
line.
- Commit that changes many plugins:

Example (made up):
```
style: fix inline declaration of arrays
```

```
style(theme)!: change dirty git repo glyph
- `!`: this goes after the `scope` (or the `type` if scope is empty), to indicate that the commit
introduces breaking changes.

BREAKING CHANGE: the glyph to indicate when a git repository is dirty has
changed from a Powerline character to a standard UTF-8 emoji.
Optionally, you can specify a message that the changelog tool will display to the user to indicate
what's changed and what they can do to deal with it. You can use multiple lines to type this message;
the changelog parser will keep reading until the end of the commit message or until it finds an empty
line.

Fixes #420
Example (made up):

Co-authored-by: Username <email>
```
```
style(theme)!: change dirty git repo glyph
BREAKING CHANGE: the glyph to indicate when a git repository is dirty has
changed from a Powerline character to a standard UTF-8 emoji.
- `subject`: a brief description of the changes. This will be displayed in the changelog. If you need
to specify other details, you can use the commit body, but it won't be visible.
Fixes #420
Formatting tricks: the commit subject may contain:
Co-authored-by: Username <email>
```

- Links to related issues or PRs by writing `#issue`. This will be highlighted by the changelog tool:
- `subject`: a brief description of the changes. This will be displayed in the changelog. If you need
to specify other details, you can use the commit body, but it won't be visible.

```
feat(archlinux): add support for aura AUR helper (#9467)
```
Formatting tricks: the commit subject may contain:

- Formatted inline code by using backticks: the text between backticks will also be highlighted by
the changelog tool:
```
feat(shell-proxy): enable unexported `DEFAULT_PROXY` setting (#9774)
```
- Links to related issues or PRs by writing `#issue`. This will be highlighted by the changelog tool:

```
feat(archlinux): add support for aura AUR helper (#9467)
```
- Formatted inline code by using backticks: the text between backticks will also be highlighted by
the changelog tool:
```
feat(shell-proxy): enable unexported `DEFAULT_PROXY` setting (#9774)
```
### Style
Expand Down
106 changes: 53 additions & 53 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,57 @@ name: 🐛 Report a bug
description: Create a report to help us improve 🤕
labels: ["bug"]
assignees:
- YisusChrist
- YisusChrist
body:
- type: markdown
attributes:
value: |
## Self Check
- Look for similar errors in existing [GitHub Issues](https://github.com/YisusChrist/AnimeSnap/issues?q=is%3Aissue) (open or closed).
- Take a look at the [documentation](https://github.com/YisusChrist/AnimeSnap/wiki) for help.
- type: textarea
validations:
required: true
attributes:
label: Describe the bug
description: A clear description of what the bug is.
- type: textarea
validations:
required: true
attributes:
label: Steps to reproduce
description: |
Steps to reproduce the problem.
placeholder: |
For example:
1. Execute with options '...'
2. Check output '...'
3. See error
- type: textarea
validations:
required: true
attributes:
label: Expected behavior
description: A brief description of what should happen.
- type: textarea
attributes:
label: Screenshots and recordings
description: |
If applicable, add screenshots to help explain your problem. You can also record an asciinema session: https://asciinema.org/
- type: input
validations:
required: true
attributes:
label: OS / Linux distribution
placeholder: Windows 10, Ubuntu 20.04, Arch Linux, macOS 10.15...
- type: input
validations:
required: true
attributes:
label: AnimeSnap version
description: Run `AnimeSnap -V` to check.
placeholder: "1.0"
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here. This can be path, platform, shell...
- type: markdown
attributes:
value: |
## Self Check
- Look for similar errors in existing [GitHub Issues](https://github.com/YisusChrist/AnimeSnap/issues?q=is%3Aissue) (open or closed).
- Take a look at the [documentation](https://github.com/YisusChrist/AnimeSnap/wiki) for help.
- type: textarea
validations:
required: true
attributes:
label: Describe the bug
description: A clear description of what the bug is.
- type: textarea
validations:
required: true
attributes:
label: Steps to reproduce
description: |
Steps to reproduce the problem.
placeholder: |
For example:
1. Execute with options '...'
2. Check output '...'
3. See error
- type: textarea
validations:
required: true
attributes:
label: Expected behavior
description: A brief description of what should happen.
- type: textarea
attributes:
label: Screenshots and recordings
description: |
If applicable, add screenshots to help explain your problem. You can also record an asciinema session: https://asciinema.org/
- type: input
validations:
required: true
attributes:
label: OS / Linux distribution
placeholder: Windows 10, Ubuntu 20.04, Arch Linux, macOS 10.15...
- type: input
validations:
required: true
attributes:
label: AnimeSnap version
description: Run `AnimeSnap -V` to check.
placeholder: "1.0"
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here. This can be path, platform, shell...
18 changes: 9 additions & 9 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Contributing to AnimeSnap
url: https://github.com/YisusChrist/AnimeSnap/blob/main/CONTRIBUTING.md
about: Guidelines for how to report an issue.
- name: Support
url: https://github.com/YisusChrist/AnimeSnap/discussions
about: Ask the community for support
- name: Documentation
url: https://github.com/YisusChrist/AnimeSnap/wiki
about: Many questions might be already answered here.
- name: Contributing to AnimeSnap
url: https://github.com/YisusChrist/AnimeSnap/blob/main/CONTRIBUTING.md
about: Guidelines for how to report an issue.
- name: Support
url: https://github.com/YisusChrist/AnimeSnap/discussions
about: Ask the community for support
- name: Documentation
url: https://github.com/YisusChrist/AnimeSnap/wiki
about: Many questions might be already answered here.
58 changes: 29 additions & 29 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,33 @@ name: 🚀 Feature request
description: Suggest a feature/idea for this project 💡
labels: ["feature"]
assignees:
- YisusChrist
- YisusChrist
body:
- type: markdown
attributes:
value: |
## Self Check
- Look for similar features in existing [GitHub Issues](https://github.com/YisusChrist/AnimeSnap/issues?q=is%3Aissue) (open or closed).
- type: textarea
attributes:
label: If the feature solves a problem you have, specify it here.
description: A description of what the problem is.
placeholder: Ex. I'm always frustrated when...
- type: textarea
attributes:
label: Describe the proposed feature.
description: A description of what you want to happen. Be as specific as possible.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A description of any alternative solutions or features you've considered. This can also include other plugins or themes.
- type: textarea
attributes:
label: Additional context
description: Add any other context, screenshots or Discord conversations about the feature request here. Also if you have any PRs related to this issue that are already open that you would like us to look at.
- type: textarea
attributes:
label: Related Issues
description: Is there any open or closed issues that is related to this feature request? If so please link them below!
- type: markdown
attributes:
value: |
## Self Check
- Look for similar features in existing [GitHub Issues](https://github.com/YisusChrist/AnimeSnap/issues?q=is%3Aissue) (open or closed).
- type: textarea
attributes:
label: If the feature solves a problem you have, specify it here.
description: A description of what the problem is.
placeholder: Ex. I'm always frustrated when...
- type: textarea
attributes:
label: Describe the proposed feature.
description: A description of what you want to happen. Be as specific as possible.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A description of any alternative solutions or features you've considered. This can also include other plugins or themes.
- type: textarea
attributes:
label: Additional context
description: Add any other context, screenshots or Discord conversations about the feature request here. Also if you have any PRs related to this issue that are already open that you would like us to look at.
- type: textarea
attributes:
label: Related Issues
description: Is there any open or closed issues that is related to this feature request? If so please link them below!
Loading

0 comments on commit 7602e42

Please sign in to comment.