Skip to content

Commit

Permalink
chore(docs): GitHub templates improve (#45)
Browse files Browse the repository at this point in the history
this is overkill for freesound-credits but I am learning stuff and
practicing for a real repo.

---------

Signed-off-by: gacallea <3269984+gacallea@users.noreply.github.com>
Co-authored-by: mergify[bot]
<37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
andreacfromtheapp committed Aug 19, 2024
1 parent 1edc0db commit 591976c
Show file tree
Hide file tree
Showing 9 changed files with 609 additions and 20 deletions.
3 changes: 3 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# The Rust Code of Conduct

The Code of Conduct for this repository [can be found online](https://www.rust-lang.org/conduct.html).
504 changes: 504 additions & 0 deletions .github/CONTRIBUTING.md

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/add_a_new_daw.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ body:
- type: checkboxes
attributes:
label: Did you check if the DAW is already supported?
description: Make sure you check the [Supported DAWs](https://github.com/gacallea/freesound_credits?tab=readme-ov-file#supported-daws) table before submitting a new DAW
description: Make sure you check the [Supported DAWs](https://github.com/gacallea/freesound-credits?tab=readme-ov-file#supported-daws) table before submitting a new DAW
options:
- label: I have checked if the DAW is already supported
required: true

- type: input
attributes:
label: "freesound_credits version (freesound_credits -V)"
placeholder: "freesound_credits 0.1.2"
label: "freesound-credits version (freesound-credits -V)"
placeholder: "freesound-credits 0.1.2"
validations:
required: true

Expand All @@ -35,10 +35,10 @@ body:

- type: checkboxes
attributes:
label: Did you test if freesound_credits works with your desired DAW sample folder?
description: Make sure that running freesound_credits yields the desired results.
label: Did you test if freesound-credits works with your desired DAW sample folder?
description: Make sure that running freesound-credits yields the desired results.
options:
- label: I have checked if the DAW works with freesound_credits
- label: I have checked if the DAW works with freesound-credits
required: true

- type: textarea
Expand Down
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,26 @@ body:
- type: markdown
attributes:
value: |
**Before** reporting an issue, make sure to search [existing issues](https://github.com/gacallea/freesound_credits/issues).
**Before** reporting an issue, make sure to search [existing issues](https://github.com/gacallea/freesound-credits/issues).
Usage questions such as ***"How do I...?"*** belong in [Discussions](https://github.com/gacallea/freesound_credits/discussions) and will be closed.
Usage questions such as ***"How do I...?"*** belong in [Discussions](https://github.com/gacallea/freesound-credits/discussions) and will be closed.
- type: checkboxes
attributes:
label: Did you check existing issues?
description: Make sure you checked all of the below before submitting an issue
options:
- label: I have updated freesound_credits to the latest version before submitting this issue
- label: I have updated freesound-credits to the latest version before submitting this issue
required: true
- label: I have searched the existing issues of freesound_credits
- label: I have searched the existing issues of freesound-credits
required: true
- label: I have searched the existing issues related to this issue
required: true

- type: input
attributes:
label: "freesound_credits version (freesound_credits -V)"
placeholder: "freesound_credits 0.1.2"
label: "freesound-credits version (freesound-credits -V)"
placeholder: "freesound-credits 0.1.2"
validations:
required: true

Expand All @@ -46,7 +46,7 @@ body:
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. Please include any related errors you see in freesound_credits.
description: A clear and concise description of what the bug is. Please include any related errors you see in freesound-credits.
validations:
required: true

Expand Down
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Community Support
url: https://github.com/gacallea/freesound-credits/discussions
about: Please ask and answer questions here.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
label: Did you check the docs?
description: Make sure you read all the docs before submitting a feature request
options:
- label: I have read all the freesound_credits docs (README.md)
- label: I have read all the freesound-credits README.md
required: true

- type: textarea
Expand Down
77 changes: 77 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Pull request template

<!--
For Work In Progress Pull Requests, please use the Draft PR feature, see
https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further
details.
NOTE: Pull Requests from forked repositories will need to be reviewed by a
Team member before any CI builds will run.
-->

## Before submitting a pull request (check all applicable)

- [ ] Read the [Contributing Guide](./github/CONTRIBUTING.md) (required)
- [ ] Read the [Code Of Conduct](/CODE_OF_CONDUCT.md) (required)
- [ ] Include tests for your changes (if necessary)
- [ ] `pre-commit run --all-files` returns no issues (required)
- [ ] Spell-check with `cargo spellcheck check` (required)
- [ ] Update the `spellcheck.dic` (if necessary)
- [ ] Update any related documentation and include any relevant screenshots
- [ ] Use [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) (required)

## Pull request type (check all applicable)

- [ ] Refactor
- [ ] Feature
- [ ] Bug Fix
- [ ] Optimization
- [ ] Documentation

## Description

<!-- describe your PR -->

### Motivation

### Solution

### Additional context

## Related Tickets & Documents

<!--
For pull requests that relate or close an issue, please include them
below. We like to follow [GitHub's guidance on linking issues to pull
requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
-->

- Related discussion #
- Related issue #
- Closes issue #

## Instructions, screenshots, recordings

_Please replace this line with instructions on how to test your changes. A note
on the devices and systems this has been tested on, as well as any relevant
images for UI changes._

### Accessibility checklist

_If your PR includes UI changes, please use this checklist:_

- [ ] Keyboard operability supported?
- [ ] Color contrast tested?

## Added/updated tests

_We encourage you to keep the code coverage percentage at 80% and above._

- [ ] Yes
- [ ] No, and this is why: _please replace this line with details_
- [ ] I need help with writing tests
6 changes: 0 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
/target
*.md
*.txt
!README.md
!TODO.md
!CONTRIBUTING.md
!CHANGELOG.md

# Editor directories and files
.vscode/*
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,9 @@ mind for any extra information.

Extract with `unzip your_project.xrns` first. Once unzipped, you will find a
`Song.xml` file and a `SamplesData` directory containing each `Instrument`.

## Contributing

Thanks for your help improving the project! :balloon: Happy to have you! Peruse
the [contributing guide](./.github/CONTRIBUTING.md) to help you get involved in
the project.

0 comments on commit 591976c

Please sign in to comment.