From 04c9b5e8c2c6a4b7995ededac99cc7052bead5c1 Mon Sep 17 00:00:00 2001 From: Amr Bashir Date: Fri, 15 Dec 2023 04:22:18 +0200 Subject: [PATCH] chore: cleanup issue and PR templates (#81) * chore: cleanup issue and PR templates * Update bug_report.md * Update feature_request.md * Delete .github/CONTRIBUTING.md --- .github/CONTRIBUTING.md | 44 ----------------------- .github/ISSUE_TEMPLATE/bug_report.md | 4 --- .github/ISSUE_TEMPLATE/feature_request.md | 4 --- .github/PULL_REQUEST_TEMPLATE.md | 41 +++++++++------------ 4 files changed, 16 insertions(+), 77 deletions(-) delete mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index f4e8dbe..0000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,44 +0,0 @@ -# Tauri Contributing Guide - -Hi! We, the maintainers, are really excited that you are interested in contributing to Tauri. Before submitting your contribution though, please make sure to take a moment and read through the [Code of Conduct](CODE_OF_CONDUCT.md), as well as the appropriate section for the contribution you intend to make: - -- [Issue Reporting Guidelines](#issue-reporting-guidelines) -- [Pull Request Guidelines](#pull-request-guidelines) -- [Development Guide](#development-guide) - -## Issue Reporting Guidelines - -- The issue list of this repo is **exclusively** for bug reports and feature requests. Non-conforming issues will be closed immediately. - -- If you have a question, you can get quick answers from the [Tauri Discord chat](https://discord.gg/SpmNs4S). - -- Try to search for your issue, it may have already been answered or even fixed in the development branch (`dev`). - -- Check if the issue is reproducible with the latest stable version of Tauri. If you are using a pre-release, please indicate the specific version you are using. - -- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Although we would love to help our users as much as possible, diagnosing issues without clear reproduction steps is extremely time-consuming and simply not sustainable. - -- Use only the minimum amount of code necessary to reproduce the unexpected behavior. A good bug report should isolate specific methods that exhibit unexpected behavior and precisely define how expectations were violated. What did you expect the method or methods to do, and how did the observed behavior differ? The more precisely you isolate the issue, the faster we can investigate. - -- Issues with no clear repro steps will not be triaged. If an issue labeled "need repro" receives no further input from the issue author for more than 5 days, it will be closed. - -- If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it. - -- Most importantly, we beg your patience: the team must balance your request against many other responsibilities — fixing other bugs, answering other questions, new features, new documentation, etc. The issue list is not paid support and we cannot make guarantees about how fast your issue can be resolved. - -## Pull Request Guidelines - -- It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging. - -- If adding new feature: - - - Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it. - -- If fixing a bug: - - If you are resolving a special issue, add `(fix: #xxxx[,#xxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `fix: update entities encoding/decoding (fix #3899)`. - - Provide detailed description of the bug in the PR, or link to an issue that does. - - -## Financial Contribution - -Tauri is an MIT-licensed open source project. Its ongoing development can be supported via [Github Sponsors](https://github.com/sponsors/nothingismagick) or [Open Collective](https://opencollective.com/tauri). We prefer Github Sponsors as donations made are doubled through the matching fund program. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fad791a..d839769 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -23,10 +23,6 @@ If applicable, add screenshots to help explain your problem. OS: Rustc: -**Would you assign yourself to resolve this bug?** -- [ ] Yes -- [ ] No - **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 3528637..6b60a5d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -16,10 +16,6 @@ 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. -**Would you assign yourself to implement this feature?** -- [ ] Yes -- [ ] No - **Additional context** 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 index 1198332..ff466a2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,30 +1,21 @@ - -### What kind of change does this PR introduce? - - -- [ ] Bugfix -- [ ] Feature -- [ ] Docs -- [ ] New Binding issue #___ -- [ ] Code style update -- [ ] Refactor -- [ ] Build-related changes -- [ ] Other, please describe: +1. Give the PR a descriptive title. -### Does this PR introduce a breaking change? - + Examples of good title: + - fix: fix incorrect generated type + - docs: update docstrings + - feat: update bindings -- [ ] Yes, and the changes were approved in issue #___ -- [ ] No + Examples of bad title: + - fix #7123 + - update docs + - fix bugs -### Checklist -- [ ] When resolving issues, they are referenced in the PR's title (e.g `fix #___, #___`) -- [ ] A change file is added if any packages will require a version bump due to this PR per [the instructions in the readme](https://github.com/tauri-apps/tauri/blob/dev/.changes/readme.md). -- [ ] I have added a convincing reason for adding this feature, if necessary - -### Other information +2. If there is a related issue, referenced in the PR text, e.g. closes #123. +3. If this change requires a new version, then add a change file in `.changes` directory with the appropriate bump, see https://github.com/tauri-apps/javascriptcore-s/blob/dev/.changes/readme.md +4. Ensure that all your commits are signed https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits +5. Ensure `cargo test` and `cargo clippy` passes. +6. Open as a draft PR if your work is still in progress. +-->