Skip to content

A Swiss Army knife for developers.

added PR template

Etienne Baudouxc211b5a1aeee
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..41240acbc
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,41 @@
+<!--- Please provide a general summary of your changes in the title above -->
+
+## Pull request type
+
+<!-- Please try to limit your pull request to one type, submit multiple pull requests if needed. -->
+
+Please check the type of change your PR introduces:
+
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Code style update (formatting, renaming)
+- [ ] Refactoring (no functional changes, no api changes)
+- [ ] Build related changes
+- [ ] Documentation content changes
+- [ ] Internationalization and localization
+- [ ] Other (please describe):
+
+## What is the current behavior?
+
+<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
+
+Issue Number: N/A
+
+## What is the new behavior?
+
+<!-- Please describe the behavior or changes that are being added by this PR. -->
+
+-
+-
+-
+
+## Other information
+
+<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
+
+## Quality check
+
+Before creating this PR, have you:
+
+- [ ] Followed the code style guideline as described in [CONTRIBUTING.md](https://github.com/veler/DevToys/blob/main/CONTRIBUTING.md)
+- [ ] Verified that the change work in Release build configuration
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2bab108e3..402676dda 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,12 +3,7 @@
You can contribute to DevToys app by:
- Report issues and bugs [here](https://github.com/veler/DevToys/issues/new?template=bug_report.md)
- Submit feature requests [here](https://github.com/veler/DevToys/issues/new?template=feature_request.md)
-- Create a pull request to help:
- * Fix an existing bug, prefix title with `[FIX] `.
- * Implement new features, prefix title with `[FEATURE] `.
- * Fix grammar errors or improve my documentations, prefix title with `[DOC] `.
- * Improve CI/CD pipeline, prefix title with `[CI] `.
- * Cleanup code and code refactoring or anything else you want to change in the project not listed above, prefix title with `[OTHER] ` or assign a custom prefix with the same format (`[LABEL] `).
+- Creating a pull request.
- Internationalization and localization:
* See instructions below.
@@ -78,3 +73,5 @@ Every tools available (i.e Base64 Encoder/Decoder, JSON Formatter, Settings...)
12. DO use prefix `Is`, `Has`, `Have`, `Any`, `Can` or similar keywords for Boolean names.
13. DO use curly brackets for single line `if`, `for` and `foreach` statements.
+
+14. DO use nullable reference type by adding `#nullable enable` at the top of every C# file.