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.

Sign up for GitHub

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

docs: Templates for issues/pull tracker #99

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

docs: Templates for issues/pull tracker #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c5478f3
adding pull request template
rpotter12 Aug 16, 2019
186e521
adding issue templates
rpotter12 Aug 16, 2019
2009162
Moved in docs
Aug 18, 2019
22268cc
Added labels and assignees to bug format
Aug 18, 2019
8896ef5
Added title in bug format
Aug 18, 2019
2506f5c
better order of yaml for bug format
Aug 18, 2019
b443096
Removed unnecesary glob
Aug 18, 2019
22d53bc
Improved syntax of bug format
Aug 18, 2019
ffc9f45
Added spaces
Aug 18, 2019
a42e3d8
Requesting verbose informations from end-user for a bug in bug format
Aug 18, 2019
fd62f4b
removed unnecessary spaces
Aug 18, 2019
85562ca
rework of feature request
Aug 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
(Thanks for sending a pull request! Please make sure you click the link above to view the contribution guidelines, then fill out the blanks below.)
-->

#### Checklist

- [ ] There is a corresponding issue for this pull request.
- [ ] My branch is up-to-date with the Upstream `master` branch.
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added necessary documentation (if appropriate)

#### Short description of what this resolves:


#### Changes proposed in this pull request:

-
-
-

<!-- Add the issue number that is fixed by this PR (In the form Fixes #123) -->

Fixes #
26 changes: 26 additions & 0 deletions docs/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug report
about: Create a report to help us improve

Copy link
Contributor

Choose a reason for hiding this comment

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

Added additional space since name and about are displayed in gui where title, labels etc are in issue

title: "BUG: "
Copy link
Contributor

@RobLoach RobLoach Sep 1, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Prefixing the issue type may not be necessary when the correct label is applied.

labels: bug-report "P3 - Normal"
assignees: kreyren nntoan
---

### Actual Behaviour
<!-- Describe how the bug manifests. -->



### Expected Behaviour
<!-- State here what the feature should enable the user to do. -->



### Steps to reproduce it
<!-- Add steps to reproduce provided bug, BE VERBOSE! -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Forcing verbose since users are usually very strait forward and forget to provide important informations.

TODO? : Asking to make short, but verbose?




### System information:
<!-- Add information about the system your facing this bug on. If you think this is irrelevant or if it's a UI bug or a feature request, please remove this section -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a omb function we could use to assist users in getting this information? asdf has a asdf info function which outputs...

OS:
Linux Earth 5.15.0-119-generic #129-Ubuntu SMP Fri Aug 2 19:25:20 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux

SHELL:
GNU bash, version 5.1.16(1)-release (x86_64-pc-linux-gnu)
Copyright (C) 2020 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>

This is free software; you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

BASH VERSION:
5.1.16(1)-release

ASDF VERSION:
v0.14.1

Copy link
Contributor

Choose a reason for hiding this comment

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

We recently added a skeleton omb, but no subcommands are implemented. We may check the upstream OMZ to see if they have an implementation of omz info or similar.

Copy link
Contributor

Choose a reason for hiding this comment

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

The closest in the upstream seems to be omz version, but this only shows the version of Oh My Zsh.

18 changes: 18 additions & 0 deletions docs/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Feature request
about: Suggest an idea for this project

title: "REQUEST: "
Copy link
Contributor

Choose a reason for hiding this comment

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

As above, when the correct label is applied, I believe prefixing "REQUEST:" to the title adds unneeded distraction.

labels: feature-request "P3 - Normal"
assignees: kreyren nntoan
Copy link
Contributor

Choose a reason for hiding this comment

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

Having all issues assigned to ya'll may get a bit spamming in your inbox. I'd personally recommend against doing this.

Suggested change
assignees: kreyren nntoan

Copy link
Contributor

Choose a reason for hiding this comment

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

This PR was made by the previous maintainers (they are still maintainers technically, but they became inactive), but I don't have a plan to merge this as is. Maybe I'll pick some parts from this PR someday when I create the templates, but I now don't see the necessity of the templates.

---

### Description/Abstract
Copy link
Contributor

Choose a reason for hiding this comment

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

Reworked feature request because i think that this is more effective

<!-- Provide short, but verbose explanation about presented feature -->


### Expected Behaviour
<!-- Provide Expected behaviour of presented feature -->

### Actual behaviour (optional)
<!-- Optionally provide actual behaviour of presented feature -->