Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework issue templates #4515

Merged
merged 4 commits into from
Sep 17, 2021
Merged

Conversation

rusty-snake
Copy link
Collaborator

No description provided.


### Checklist

- [ ] The profile (and redirect profile if exists) hasn't already been fixed [upstream](https://github.com/netblue30/firejail/tree/master/etc).
- [ ] The issues is caused by firejail (i.e running the program by path (e.g. `/usr/bin/vlc`) "fixes" it).
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe move both here:

Suggested change
- [ ] The issues is caused by firejail (i.e running the program by path (e.g. `/usr/bin/vlc`) "fixes" it).
- [ ] The issue is caused by the firejail profile (i.e. it works using `firejail --noprofile /path/to/program`).
- [ ] The issue is caused by firejail (i.e it works using `/path/to/program`).

Copy link
Collaborator

@kmk3 kmk3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding me a reviewer and sorry for the delay.

I have some thoughts on bug_report.md, but it's kind of hard to review using
the default tools, considering the amount of changes done at once. Can I just
commit my ideas to the branch and then you keep what you agree with and delete
(and maybe comment on) the rest?

.github/ISSUE_TEMPLATE/config.yml Show resolved Hide resolved

### Additional context

_Add any other context or screenshots about the feature request here._
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea of having a feature request template.

But what about the "Ideas" category?

When would a feature request be posted using the template vs in a new
discussion?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good points. Spontaneous I would say use "Ideas" if you have an idea and if we come to something more concrete (i.e. how a new option should integrate into profiles, ...) a detailed feature request is written.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rusty-snake on Sep 16:

Good points. Spontaneous I would say use "Ideas" if you have an idea and if
we come to something more concrete (i.e. how a new option should integrate
into profiles, ...) a detailed feature request is written.

I thought the same. My worry was mostly that even without a template people
sometimes already open issues for less detailed feature requests instead of
using discussions. But I guess we can convert to a discussion in those cases,
so nevermind.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should add a not to feature_request.md (in a later PR) or to CONTRIBUTING.md.

Where we are already at CONTRIBUTING.md, this needs to be updated too. Especially for discussions.

@rusty-snake
Copy link
Collaborator Author

Can I just commit my ideas to the branch and then you keep what you agree with and delete
(and maybe comment on) the rest?

+1

@kmk3
Copy link
Collaborator

kmk3 commented Sep 17, 2021

I have pushed some commits; feel free to squash/fixup any.

I had some larger suggestions, but honestly they're not worth keeping this open
further. I might just comment some thoughts later in here for reference.

There are also some more ideas that I'll just put in a new PR.

Copy link
Collaborator Author

@rusty-snake rusty-snake left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kmk3 just commit or resolve them.

.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.md Outdated Show resolved Hide resolved
kmk3 and others added 2 commits September 17, 2021 14:37
Co-authored-by: rusty-snake <41237666+rusty-snake@users.noreply.github.com>
Co-authored-by: rusty-snake <41237666+rusty-snake@users.noreply.github.com>
@rusty-snake rusty-snake merged commit 7f2597d into netblue30:master Sep 17, 2021
@rusty-snake rusty-snake deleted the rework-issue-template branch September 17, 2021 15:04
@kmk3
Copy link
Collaborator

kmk3 commented Sep 19, 2021

@rusty-snake By the way, feel free to squash/fixup commits like this that I
make on future PRs, as if you made them yourself:

  • commit a138a65 ("bug_report.md: remove extraneous newline")

That is, commits that only fix typos/whitespace/indentation of other commits in
the PR.

They're just mechanical changes to (at the time of making) unmerged commits, so
I don't really care about taking credit for those; I'd rather just see better
merged commits/less commits.

To make things simpler, I think I'll just write "(fixup)" in the commit message
of such commits or just use git commit --fixup=commit and write below the
auto-generated message.

@rusty-snake
Copy link
Collaborator Author

commit a138a65 ("bug_report.md: remove extraneous newline")

I had overlooked

git commit --fixup=commit

Sounds better as it allows a simple git rebase -i --autostash --autosquash <commit>.

@kmk3
Copy link
Collaborator

kmk3 commented Sep 19, 2021

@rusty-snake commented on Sep 19:

commit
a138a65
("bug_report.md: remove extraneous newline")

I had overlooked

git commit --fixup=commit

Sounds better as it allows a simple git rebase -i --autostash --autosquash <commit>.

Alright, I'll do that one then.

OT: I wish everyone knew how to rebase, so that I could do this on every PR
rather than use the IMO clunky suggestions feature.

kmk3 added a commit that referenced this pull request Feb 6, 2022
kmk3 added a commit to kmk3/firejail that referenced this pull request Sep 10, 2024
Changes:

* Sync bug_report.md with build_issue.md (reword items and add Linux
  kernel item)
* Add a colon to the end of every item (to clarify where to add the
  information)
* Add the Environment section to feature_request.md

The last item is intended as a basic sanity check, as users using an
outdated version of firejail may request something that was already
implemented (for example, see netblue30#6461).

Relates to netblue30#4515 netblue30#6423.
kmk3 added a commit to kmk3/firejail that referenced this pull request Sep 13, 2024
Changes:

* Sync bug_report.md with build_issue.md (reword items and add Linux
  kernel item)
* Add a colon to the end of every item (to clarify where to add the
  information)
* Add the Environment section to feature_request.md

The last item is intended as a basic sanity check, as users using an
outdated version of firejail may request something that was already
implemented (for example, see netblue30#6461).

Relates to netblue30#4515 netblue30#6423.
kmk3 added a commit that referenced this pull request Sep 13, 2024
Changes:

* Sync bug_report.md with build_issue.md (reword items and add Linux
  kernel item)
* Add a colon to the end of every item (to clarify where to add the
  information)
* Add the Environment section to feature_request.md

The last item is intended as a basic sanity check, as users using an
outdated version of firejail may request something that was already
implemented (for example, see #6461).

Relates to #4515 #6423.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done (on RELNOTES)
Development

Successfully merging this pull request may close these issues.

2 participants