diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 523a711..72abc43 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -3,6 +3,14 @@ description: The template for all 3rd party bug reports labels: - bug body: + - type: markdown + attributes: + value: >- + # Before You Begin + + Make sure that you have checked the [issues](https://github.com/Oliver-Akins/file-hider/issues) + page for any bug reports that are similar to yours, if you've found a + similar one, make a comment on that issue with your extra information. - type: markdown attributes: value: '# Version Information' @@ -60,17 +68,3 @@ body: List steps that can reproduce the issue. If this is left blank, issues may be deemed lower priority and take longer to fix. value: 1. Hide a file/folder - - type: markdown - attributes: - value: |- - --- - - # Confirmations - - type: checkboxes - attributes: - label: Have you? - options: - - label: >- - I have checked that there isn't already a bug on the GitHub issue - tracker for this issue - required: true diff --git a/.github/contributing.md b/.github/contributing.md new file mode 100644 index 0000000..3575579 --- /dev/null +++ b/.github/contributing.md @@ -0,0 +1,59 @@ +# Contributing Guidelines + +## General Overview +Code can be edited and changed on the `main` branch, any large features or + +## Code Style + + + +## Extras +If there's anything you think was missed please open a [new discussion](https://github.com/Oliver-Akins/file-hider/discussions/new?category=general) +on GitHub so it can be discussed. \ No newline at end of file diff --git a/.gitignore b/.gitignore index 26e335f..f43585c 100644 --- a/.gitignore +++ b/.gitignore @@ -18,6 +18,7 @@ main.js # obsidian data.json +obsidian-releases # Exclude macOS Finder (System Explorer) View States .DS_Store diff --git a/README.md b/README.md index 8a45b72..2b13651 100644 --- a/README.md +++ b/README.md @@ -34,4 +34,8 @@ and adding the `File Hider: Toggle Visibility` command. ## Issues? Feature Requests? If you want to report a bug or request a new feature, go to the [GitHub Repo](https://github.com/Oliver-Akins/file-hider/issues/new/choose) and -open an issue. \ No newline at end of file +open an issue. + +## Contributing +If you would like to contribute to the codebase, please make sure to read the +[contributing guidelines](https://github.com/Oliver-Akins/file-hider/blob/main/.github/contributing.md) \ No newline at end of file