Skip to content

Commit 0c721df

Browse files
committed
Issues policy
Nothing changes, but the wording is more honest
1 parent f6876d2 commit 0c721df

File tree

5 files changed

+34
-48
lines changed

5 files changed

+34
-48
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1 @@
11
blank_issues_enabled: false
2-
contact_links:
3-
- name: Bug report
4-
url: https://github.com/nikitabobko/AeroSpace/discussions/categories/potential-bugs
5-
about: 'All bug reports must firstly go to #potential-bugs GH discussion'
6-
- name: Feature request/idea
7-
url: https://github.com/nikitabobko/AeroSpace/discussions/categories/feature-ideas
8-
about: 'All feature requests must be firstly discussed in #feature-ideas GH discussion'
9-
- name: Ask a question
10-
url: https://github.com/nikitabobko/AeroSpace/discussions/categories/questions-and-answers
11-
about: 'Please ask and answer questions here'

.github/ISSUE_TEMPLATE/dummy.yml

Lines changed: 0 additions & 13 deletions
This file was deleted.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: New Issue
2+
description: New Issue
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Unfortunately, AeroSpace project doesn't accept bug reports and feature requests from everyone. See: https://github.com/nikitabobko/AeroSpace/issues/947
8+
- type: checkboxes
9+
id: checkbox
10+
attributes:
11+
label: '_'
12+
options:
13+
- label: |
14+
I read https://github.com/nikitabobko/AeroSpace/issues/947
15+
required: true

CONTRIBUTING.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# Contributing
22

3-
Look who wants to contribute! Nice to see you here, let me show you what you can do :)
3+
## Users cannot create GitHub Issues directly
4+
5+
Unfortunately, AeroSpace project doesn't accept bug reports and feature requests from everyone.
6+
7+
The submitted Issues are often either obvious duplicates, environmental problems, or configuration errors by the users themselves.
8+
For a hobby project, I don't have enough time and energy to process every such submitted Issue.
9+
10+
**As an alternative, you can start a Discussion on GitHub discussions forum** https://github.com/nikitabobko/AeroSpace/discussions.
11+
Any Discussion which clearly identifies a problem and can be confirmed or reproduced will be converted to an Issue by maintainers.
12+
13+
Thank you for your understanding.
414

515
## Submit bugs and feature ideas
616

@@ -30,30 +40,14 @@ Rules:
3040
* Synopsis, if you suggest a new command
3141
* Mental model description
3242

33-
## Users cannot create GitHub Issues directly
34-
35-
Users are not allowed to create Issues directly in this repository - we ask that you create a Discussion first.
36-
37-
Users can't create issues directly because:
38-
- Users submit too many duplicates without prior search
39-
- A lot of user issues are misunderstandings, environmental problems, or configuration errors by the users themselves
40-
- Few people can formulate proper bug reports
41-
- Even fewer people can formulate proper, actionable feature requests that align with other existing/planned features and the overall AeroSpace mental model
42-
43-
Any Discussion which clearly identifies a problem and can be confirmed or reproduced will be converted to an Issue by maintainers.
44-
45-
This whole pattern makes it easier for maintainers or contributors to find issues to work on.
46-
Issues are like a publicly observable maintainers' inbox.
47-
We want to keep this inbox tidy and clean.
48-
4943
## Discuss issues/discussions
5044

5145
One of the most useful thing you can do is to discuss issues/discussions.
5246

5347
Imagine that you were assigned to fix the issue.
5448
Try to suggest the best approach and design on how to fix the issue.
5549
Suggest the synopsis/config format, reason in written form what is good about it, what is bad about it, what are the alternatives, etc.
56-
Basically, see the "Prior discussion" section in [Submit Pull Requests](#submit-pull-requests) :)
50+
Basically, see the "Prior discussion" section in [Submit Pull Requests](#submit-pull-requests).
5751

5852
If you have something to contribute to the conversation. Do it!
5953

@@ -67,6 +61,8 @@ You can take a look at the following issues:
6761

6862
## Submit Pull Requests
6963

64+
Small and trivial improvements can be submitted without any discussion.
65+
7066
**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.
7167

7268
Please create a new discussion and describe you want to do.
@@ -83,8 +79,6 @@ Consider including
8379

8480
Discussing that you want to do something doesn't put any obligations on you. If you don't want to start the discussion just because you're afraid that you won't do it. Don't be afraid!
8581

86-
Small and trivial improvements can be submitted without any discussion.
87-
8882
**Commit hygiene**. Each submitted commit must be atomic change (a Pull Request may contain several commits). Don't introduce new functional changes together with refactorings in the same commit.
8983

9084
Similarly, when implementing features and bug fixes, please stick to the structure of the codebase as much as possible and do not take this as an opportunity to do some "refactoring along the way".

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,11 @@ Other installation options: https://nikitabobko.github.io/AeroSpace/guide#instal
5757
5858
## Community, discussions, issues
5959

60+
Unfortunately, AeroSpace project doesn't accept bug reports and feature requests from everyone.
61+
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
62+
6063
Community discussions happen at GitHub Discussions.
61-
There you can report bugs, propose new features, ask your questions, show off your setup, or just chat.
64+
There you can discuss bugs, propose new features, ask your questions, show off your setup, or just chat.
6265

6366
There are 7 channels:
6467
- [#all](https://github.com/nikitabobko/AeroSpace/discussions).
@@ -78,15 +81,12 @@ There are 7 channels:
7881
[RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/general.atom?discussions_q=sort%3Adate_created+category%3Ageneral).
7982
- [#potential-bugs](https://github.com/nikitabobko/AeroSpace/discussions/categories/potential-bugs).
8083
[RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/potential-bugs.atom?discussions_q=category%3Apotential-bugs+sort%3Adate_created).
81-
If you think that you have encountered a bug, you can report it here.
84+
If you think that you have encountered a bug, you can discuss your bugs here.
8285
- [#questions-and-answers](https://github.com/nikitabobko/AeroSpace/discussions/categories/questions-and-answers).
8386
[RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/questions-and-answers.atom?discussions_q=category%3Aquestions-and-answers+sort%3Adate_created).
8487
Everyone is welcome to ask questions.
8588
Everyone is encouraged to answer other people's questions.
8689

87-
You're welcome to submit bug reports and feature ideas in GitHub Discussions.
88-
See: [CONTRIBUTING.md](./CONTRIBUTING.md)
89-
9090
## Development
9191

9292
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)

0 commit comments

Comments
 (0)