diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..301e1a2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report to help improve BooDark + +--- + +### Describe the bug + +A clear and concise description of what the bug is. + +### To Reproduce + +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +### Expected behavior + +A clear and concise description of what you expected to happen. + +### Screenshots + +If applicable, add screenshots to help explain the bug. + +### Additional context + +- Operating system: +- Browser: +- phpMyAdmin version: +- BooDark version: + +Add any other context about the bug here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..cebb3f3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for BooDark + +--- + +### Is your feature request related to a problem? Please describe. + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +### Describe the solution you'd like + +A clear and concise description of what you want to happen. + +### Describe alternatives you've considered + +A clear and concise description of any alternative solutions or features you've considered. + +### Additional context + +- BooDark version: + +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..1e67e0f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,10 @@ +### Description + +Please describe your pull request. + +Fixes # + +Before submitting pull request, please review the following checklist: + +- [ ] Make sure you have read our [CONTRIBUTING.md](https://github.com/adorade/boodark/blob/main/CONTRIBUTING.md) document. +- [ ] Every commit has a descriptive commit message. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a82709c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing to BooDark + +As an open-source project, BooDark welcomes contributions of many forms. + +## Bug reporting + +I appreciate your effort to improve **BooDark** by submitting a bug report. Before doing so, please check the following things: + +1. Check whether the bug you face **hasn't been already reported**. Checking for duplicate reports takes time that could be used to fix other bugs or make improvements. + +2. Specify the **BooDark**, **phpMyAdmin** information that may be helpful to fix the problem, especially exact **version numbers**. + +3. If you got some error, please **describe what happened**. + +4. Provide easy steps to reproduce. + +Thanks for your help! + +Please report [bugs on GitHub][1]. + +[1]: https://github.com/adorade/boodark/issues/new diff --git a/README.md b/README.md index 7efd231..e108016 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,6 @@ [![license](https://img.shields.io/github/license/adorade/boodark)](https://mit-license.org) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/adorade/boodark/node.yml?label=Test%20CI&logo=github)](https://github.com/adorade/boodark/actions/workflows/node.yml) - > Bootstrap Dark theme for phpMyAdmin - Supported versions: 5.2 @@ -106,7 +105,8 @@ mv themes/boodark/css/theme-nord.css themes/boodark/css/theme.css ## Bugs and feature requests -Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/adorade/boodark/issues/new). +Have a bug or a feature request? Please search for existing and closed issues. +If your problem or idea is not addressed yet, [please open a new issue](https://github.com/adorade/boodark/issues/new). ## License