diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..eeefc0d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,3 @@ +**DO NOT OPEN A NEW ISSUE. PLEASE USE THE DISCUSSIONS SECTION.** + +**I DIDN'T READ THE ABOVE LINE. PLEASE CLOSE THIS ISSUE.** diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 5625b6f1..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: Bug report -about: Something doesn't works as expected. -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**Related issues you could find** -Please make sure to search for duplicates. -If you couldn't find the duplicates, linking related issues is helpful anyway. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3d983c30..60e9b95b 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,11 @@ +blank_issues_enabled: true contact_links: - - name: Ask a question - url: https://github.com/nikitabobko/AeroSpace/discussions/categories/questions-and-answers - about: Please ask and answer questions here. + - name: Bug report + url: https://github.com/nikitabobko/AeroSpace/discussions/categories/potential-bug + about: 'All bug reports must firstly go to #potential-bug GH discussion' - name: Feature request/idea url: https://github.com/nikitabobko/AeroSpace/discussions/categories/feature-ideas - about: All not yet well-defined feature requests must be firstly brainstormed in "feature ideas". + about: 'All feature requests must be firstly discussed in #feature-ideas GH discussion' + - name: Ask a question + url: https://github.com/nikitabobko/AeroSpace/discussions/categories/questions-and-answers + about: 'Please ask and answer questions here' diff --git a/.github/ISSUE_TEMPLATE/feature-proposal.md b/.github/ISSUE_TEMPLATE/feature-proposal.md deleted file mode 100644 index 46505fa9..00000000 --- a/.github/ISSUE_TEMPLATE/feature-proposal.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Feature proposal -about: 'Create a well-defined and complete feature proposal. If you are unsure you can brainstorm your ideas in #feature-ideas in GitHub Discusssions.' -title: '' -labels: feature-proposal -assignees: '' - ---- - - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2621efe9..2ab8fd7e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,18 +2,14 @@ Look who wants to contribute! Nice to see you here, let me show you what you can do :) -## Report Issues +## Submit bugs and feature ideas -There are only two types of issues: -* Feature proposal -* Bug report - -Feature proposal is not a feature request/idea but a well-defined and complete proposal of feature which is clear how to implement. -If you're unsure you can brainstorm your ideas in [#feature-ideas](https://github.com/nikitabobko/AeroSpace/discussions/categories/feature-ideas) in GitHub Discusssions. +Submit bugs to https://github.com/nikitabobko/AeroSpace/discussions/categories/potential-bugs +Submit feature ideas to https://github.com/nikitabobko/AeroSpace/discussions/categories/feature-ideas Rules: -* Search for duplicates before reporting new issues -* Vote for issues that you find useful with 👍 reaction +* Search for duplicates (in GitHub Issues and Discusssions) before creating a new discussion +* Upvote for issues/discussions that you find useful **Consider including in bug reports** @@ -28,14 +24,31 @@ Rules: **Consider including in feature request** * Use cases! +* Did I mention use cases? * Alternative approaches * Links to docs of similar features in other window managers that you know * Synopsis, if you suggest a new command -* Alternative command names, if you suggest a new command +* Mental model description + +## Users cannot create GitHub Issues directly + +Users are not allowed to create Issues directly in this repository - we ask that you create a Discussion first. + +Users can't create issues directly because: +- Users submit too many duplicates without prior search +- A lot of user issues are misunderstandings, environmental problems, or configuration errors by the users themselves +- Few people can formulate proper bug reports +- Even fewer people can formulate proper, actionable feature requests that align with other existing/planned features and the overall AeroSpace mental model + +Any Discussion which clearly identifies a problem and can be confirmed or reproduced will be converted to an Issue by maintainers. + +This whole pattern makes it easier for maintainers or contributors to find issues to work on. +Issues are like a publicly observable maintainers' inbox. +We want to keep this inbox tidy and clean. -## Discuss issues +## Discuss issues/discussions -One of the most useful thing you can do is to discuss issues. +One of the most useful thing you can do is to discuss issues/discussions. Imagine that you were assigned to fix the issue. Try to suggest the best approach and design on how to fix the issue. @@ -56,7 +69,7 @@ You can take a look at the following issues: **Prior discussion**. For non-trivial changes (such as user visible changes), it's always better to ask for prior approval and discuss what you want to do before doing it. -Please create an issue (or write a comment in existing one) and describe you want to do. +Please create a new discussion and describe you want to do. Consider including diff --git a/README.md b/README.md index fb3b0d03..f3678cde 100644 --- a/README.md +++ b/README.md @@ -55,10 +55,10 @@ Other installation options: https://nikitabobko.github.io/AeroSpace/guide#instal > automatically delete `com.apple.quarantine` attribute, that's why the app should work out of the box, without any warnings that > "Apple cannot check AeroSpace for malicious software" -## Community, discussions, issues, pull requests +## Community, discussions, issues -Informal community discussions happen at GitHub Discussions. -There you can ask your questions, show off your setup, bring other topic, or just chat. +Community discussions happen at GitHub Discussions. +There you can report bugs, propose new features, ask your questions, show off your setup, or just chat. There are 6 channels: - [#all](https://github.com/nikitabobko/AeroSpace/discussions). @@ -76,17 +76,17 @@ There are 6 channels: [RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/feature-ideas.atom?discussions_q=category%3Afeature-ideas+sort%3Adate_created). - [#general](https://github.com/nikitabobko/AeroSpace/discussions/categories/general). [RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/general.atom?discussions_q=sort%3Adate_created+category%3Ageneral). +- [#potential-bugs](https://github.com/nikitabobko/AeroSpace/discussions/categories/potential-bugs). + [RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/potential-bugs.atom?discussions_q=category%3Apotential-bugs+sort%3Adate_created). + If you think that you encourage a bug, you can report it here. - [#questions-and-answers](https://github.com/nikitabobko/AeroSpace/discussions/categories/questions-and-answers). [RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/questions-and-answers.atom?discussions_q=category%3Aquestions-and-answers+sort%3Adate_created). Everyone is welcome to ask questions. Everyone is encouraged to answer other people's questions. -You're welcome to submit bug reports and well-defined feature proposals in GitHub issues. -You're welcome to submit pull requests as well. +You're welcome to submit bug reports and feature ideas in GitHub Discussions. See: [CONTRIBUTING.md](./CONTRIBUTING.md) -**Issues vs Discussions:** Issues are formal and well-defined. Discussions are informal and casual. - ## Development A notes on how to setup the project, build it, how to run the tests, etc. can be found here: [dev-docs/development.md](./dev-docs/development.md) diff --git a/Sources/Common/util/commonUtil.swift b/Sources/Common/util/commonUtil.swift index e7cf56e4..a8f3cb29 100644 --- a/Sources/Common/util/commonUtil.swift +++ b/Sources/Common/util/commonUtil.swift @@ -19,7 +19,7 @@ public func errorT( let message = """ Please report to: - https://github.com/nikitabobko/AeroSpace/issues + https://github.com/nikitabobko/AeroSpace/discussions/categories/potential-bugs Please describe what you did to trigger this error Message: \(_message) diff --git a/docs/util/man-footer.adoc b/docs/util/man-footer.adoc index a18e0443..c9313988 100644 --- a/docs/util/man-footer.adoc +++ b/docs/util/man-footer.adoc @@ -5,7 +5,9 @@ == BUGS -Bugs can be reported to https://github.com/nikitabobko/AeroSpace/issues/new +Bugs can be reported to https://github.com/nikitabobko/AeroSpace/discussions/categories/potential-bugs + +Maintainers will move verified bugs to https://github.com/nikitabobko/AeroSpace/issues == License