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

[#897] - Add issue templates #1003

Merged
merged 3 commits into from
Jul 13, 2023
Merged

Conversation

EdgarRamirezFuentes
Copy link
Contributor

Resolve #897 by adding bug report, documentation related, enhancement request, feature request, and question issue templates.

Following this checklist to help us incorporate your contribution quickly and easily:

  • Make sure there is a GitHub issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a GitHub issue. Your pull request should address just this issue, without pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [#XXX] - Fixes bug in SessionManager,
    where you replace #XXX with the appropriate GitHub issue. Best practice
    is to use the GitHub issue title in the pull request title and in the first line of the commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • add fixes #XXX if merging the PR should close a related issue.
  • Run mvn clean install apache-rat:check to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.
  • If you have a group of commits related to the same change, please squash your commits into one and force push your branch using git rebase -i.

Trivial changes like typos do not require a GitHub issue (javadoc, comments...).
In this case, just format the pull request title like [DOC] - Add javadoc in SessionManager.

If this is your first contribution, you have to read the Contribution Guidelines

If your pull request is about ~20 lines of code you don't need to sign an Individual Contributor License Agreement
if you are unsure please ask on the developers list.

To make clear that you license your contribution under the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

Copy link
Contributor

@lprimak lprimak left a comment

Choose a reason for hiding this comment

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

Im inclined to approve this.
However, since I don't really have any expertise in setting these up,
can somebody else take a look as well :)

Copy link
Member

@fpapon fpapon left a comment

Choose a reason for hiding this comment

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

Just a little comment about the version list in the bug report template, otherwise LGTM.
@EdgarRamirezFuentes Thank you for your contribution!

attributes:
label: Shiro version
description: Describe the Shiro version.
options:
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure this is a good idea to provide a version list because we will need to maintain it up to date.
May be a simple input text field should be enough.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Understood!
I made the changes in the bug report file, and switched the Shiro version to a textarea. 😄

In the bug_report.yml file switched the dropdow to specify the version of Shiro to a textarea.
Copy link
Member

@fpapon fpapon left a comment

Choose a reason for hiding this comment

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

LGTM!

@fpapon fpapon requested a review from bmarwell July 7, 2023 16:16
@fpapon
Copy link
Member

fpapon commented Jul 7, 2023

@bmarwell is it ok with what you had in mind?


- type: dropdown
attributes:
label: Environment
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can omit the environment b/c Java.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe replace with a text field for application server, Java version, etc

Copy link
Contributor

Choose a reason for hiding this comment

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

i.e Environment? :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You mean something like this?
Captura de pantalla 2023-07-07 a la(s) 16 15 56


- type: textarea
attributes:
label: What happened
Copy link
Contributor

Choose a reason for hiding this comment

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

"what was the actual outcome"

Copy link
Contributor

Choose a reason for hiding this comment

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

It's missing "what did you expect instead"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So, I change the label to "what was the actual outcome" instead of "What happened", and add a new textarea with the label "what did you expect instead"?


- type: checkboxes
attributes:
label: Are you willing to submit PR?
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not required imho. Or maybe rephrase it? @bdemers might want to suggest something?

@bmarwell
Copy link
Contributor

bmarwell commented Jul 7, 2023

@bmarwell is it ok with what you had in mind?

It's a great start!

@lprimak
Copy link
Contributor

lprimak commented Jul 11, 2023

I would say to merge this "as is" and then update it when we figure out what the exact copy should read.
WDYT?

@EdgarRamirezFuentes
Copy link
Contributor Author

@lprimak
I could commit the modifications I made in the environment field, and It could be merged and modified later as you mentioned.

@lprimak
Copy link
Contributor

lprimak commented Jul 11, 2023

@bmarwell What do you think?

@bmarwell
Copy link
Contributor

Yes, please change accordingly.

@EdgarRamirezFuentes
Copy link
Contributor Author

Done!
I modified the environment field to be a text field, and added the fields to explain what was the actual and expected outcome.

@lprimak lprimak requested a review from bmarwell July 13, 2023 02:23
Copy link
Contributor

@bmarwell bmarwell left a comment

Choose a reason for hiding this comment

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

Yup, that's a start!

@fpapon
Copy link
Member

fpapon commented Jul 13, 2023

@EdgarRamirezFuentes thanks for your first contribution!

@fpapon fpapon merged commit 7f4c28f into apache:main Jul 13, 2023
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
4 participants