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

Enable GitHub issues #599

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Enable GitHub issues #599

wants to merge 1 commit into from

Conversation

slawekjaranowski
Copy link
Member

@slawekjaranowski slawekjaranowski commented Dec 21, 2024

I hope that we not need an issues migration for this project - it is simply current state of site.

We have 69 issues opened now:
https://issues.apache.org/jira/projects/MNGSITE

After it we can create a pined issue with information and link to JIRA

Next steps after merge:

  • block for creating new issues in JIRA - existing issues should be possible to comments, closing and so on

Copy link
Contributor

@Bukama Bukama left a comment

Choose a reason for hiding this comment

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

According the removal of the JIRA link: When not migrating issues, shall we keep the link for some time with the note that it's read only (assuming that JIRA issue creation will be disabled as discussed on mailing list)?

Aside from this: non binding approval

@slawekjaranowski
Copy link
Member Author

According the removal of the JIRA link: When not migrating issues, shall we keep the link for some time with the note that it's read only (assuming that JIRA issue creation will be disabled as discussed on mailing list)?

I will add an pined issue with information and template which also contain JIRA link

@slawekjaranowski
Copy link
Member Author

Issues template added.

id: massage
attributes:
label: Please describe a bug
description: Please describe a bug
Copy link
Contributor

Choose a reason for hiding this comment

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

a bug to the bug maybe?
I would also point out to specify the expected behavior, not only a description of the "seen" behavior.

Copy link
Member Author

Choose a reason for hiding this comment

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

ok there is next proposition

Copy link
Member Author

Choose a reason for hiding this comment

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

as it is documentation project I would not to complicate the bug form

@slawekjaranowski slawekjaranowski force-pushed the github-issues branch 2 times, most recently from 876518d to 31f6101 Compare December 21, 2024 20:17
@slawekjaranowski
Copy link
Member Author

Issue page will be look like:

image

bug report:
image

and
image

@Bukama
Copy link
Contributor

Bukama commented Dec 22, 2024

Thanks for the preview to get a better idea how it will look. My thoughts below.

Issue page will be look like:

General:
I link that you thank people to take the time to fill out the forms - we value their time and effort!

The part "and answer" part of "Please ask and answer on the mailing list" sounds strange, like "Please ask your question on the mailing list - oh and answer it by yourself too please, so we don't have to - thanks!" 🙈

Issue page:
I think you want to create a template, easily reuseable by other repositories, but as were are in the context of a website, maybe we should rephrase "File a bug report" to something containing also "mistake" or "error" aiming at outdated or wrong information on the website (in contrast to a technical bug, like broken links etc.). But maybe that's just me focusing on texts for non/less IT people (what I write a lot at work).

Bug report:
"An/Opening issue is not needed..."

In site's context I think this is okay, but I don't like it in general as it may result in situations where people try fixing something which is either not wrong or do it in a wrong way. What I want to say with this: I like to discuss / agree on bugs before fixing them (more true in open source projects than at my work where all have good knowledge of the code and system).

The title and description should be a required field.

Improvement:
The title and description should be a required field.

value: |
Thanks for taking the time to fill out this bug report!

Issue is **not needed** if you want to create a Pull Request with fixing.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is "with fixing" correct? It sounds off.

Copy link
Member Author

Choose a reason for hiding this comment

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

My idea is to not required issue creating if someone has a plan to make a PR in the same time.

Big or more complicated planned change should have an issue to first discuss before starting implementation.

So how to say in simple way?

Copy link
Contributor

Choose a reason for hiding this comment

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

"Simple fixes in single PRs do not require issues."

That said, some (not all) simple fixes do require issues. For instance, a one-line change that fixes a really serious bug should have an issue to show up in the release notes, but a one line change that corrects a spelling error in a comment should not.

Copy link
Member Author

Choose a reason for hiding this comment

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

It is a documentation site ... so we don't have a release notes here - it is current state only.

Issue is **not needed** if you want to create a Pull Request with fixing.

- type: textarea
id: massage
Copy link
Contributor

Choose a reason for hiding this comment

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

Is massage correct? That's a strange ID for this project. Was perhaps message meant?

Copy link
Member Author

Choose a reason for hiding this comment

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

.github/ISSUE_TEMPLATE/BUG.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/IMPROVEMENT.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/IMPROVEMENT.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/IMPROVEMENT.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/IMPROVEMENT.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@elharo elharo left a comment

Choose a reason for hiding this comment

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

I'm unclear on what happens to old issues under this proposal. Are they now available in github or not? Or are some available and some not? And of so which ones?

@slawekjaranowski
Copy link
Member Author

I'm unclear on what happens to old issues under this proposal. Are they now available in github or not? Or are some available and some not? And of so which ones?

My proposition is to not migrate as we have a link to old jira in templates and we can continue work on in.

We should only block creating new issues in JIRA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants