diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md new file mode 100644 index 0000000..919e08d --- /dev/null +++ b/.gitlab/issue_templates/Bug.md @@ -0,0 +1,44 @@ +## Description + +Please write a clear and concise description of the issue you are getting. + +## Machine Information + +Please write down the specification of your machine. + +### Example: + +**Device**: Lenovo ideapad 330S-14IKB 81F4\ +**Operating System**: Arch Linux rolling\ +**CPU**: Intel Core i7-7700K x86_64 (write down the CPU architechture too)\ +**Kernel**: 5.14.14-hardened1-1-hardened\ +**Desktop Environment**: N/A (Linux only; **explicitly** leave as N/A if you are using bare WM)\ +**Window Manager**: Sway 1.6.1-2 (Linux only)\ +**Install Method**: Arch User Repository (write down from where you installed the software)\ +**Desktop Server Protocol**: Wayland 1.19.0-2 (Linux only) + +If you believe that some of these informations are irrelevant (such as DE and WM information on Windows/MacOS, you may leave them out). Additionally, add information missing from the above example should it be important for the bug. + +## Steps to Reproduce + +Please write down the steps to reproduce the issue. + +## Expected Result + +Please write down the result you were expecting. + +## Actual Result + +Please write down the result that you found. + +## Screenshots + +Please attach screenshots here if there are any. + +## Logs + +Please write down logs you found here if there are any. + +## Additional Notes and Information + +Please write down any additional notes and information you find useful. Leave blank if you don't have any. \ No newline at end of file diff --git a/.gitlab/issue_templates/Feature Request.md b/.gitlab/issue_templates/Feature Request.md new file mode 100644 index 0000000..4bb1899 --- /dev/null +++ b/.gitlab/issue_templates/Feature Request.md @@ -0,0 +1,26 @@ +## Description + +Please write a clear and concise description of the issue you are getting. + +## Necessity + +Please write down why this feature should be implemented. + +## Implementation +Please write down a technical description on how we should implement this feature. + +If this is unneened, please leave this blank. + +### Example + +The URI template is as below. The `GUID` parameter is for the guid of the server. If there is any, the server's password can be set using the `PASSWD` argument. The mode can be set too with the `MODE` argument. The `MODE` argument can be set with either `player`, `spectactor`, or `commander`. + +``` +mod://connect/GUID?passwd=PASSWD&mode=MODE +``` + +## Additional Notes and Information + +Please write down any additional notes and information you find useful. Leave blank if you don't have any. + + diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..faf9a85 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,11 @@ +repos: + - repo: https://github.com/commitizen-tools/commitizen + rev: master + hooks: + - id: commitizen + stages: [commit-msg] + - repo: https://github.com/doublify/pre-commit-rust + rev: master + hooks: + - id: fmt + - id: cargo-check