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

README: clarify what the issue tracker covers #322

Merged
merged 5 commits into from
Nov 13, 2023

Conversation

felixfontein
Copy link
Contributor

In the forum, it was was remarked that it is not clear what kind of issues can and should be created in this repository's issue tracker. This PR adds a section at the top of the README with some details on what can (and what should not be) handled here.

Ref: https://forum.ansible.com/t/trying-to-get-a-message-to-the-right-team-about-a-8-6-release-issue/2274/3

Copy link
Collaborator

@mariolenz mariolenz left a comment

Choose a reason for hiding this comment

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

We also use issues to track the removal of collections in future major releases. Should we mention this explicitly?

@felixfontein
Copy link
Contributor Author

Good point! There's also adding of collections (if it can't be done directly with a PR, for example due to feature freezes for new major releases) and renaming of collections. I've added all three.

Copy link
Collaborator

@mariolenz mariolenz left a comment

Choose a reason for hiding this comment

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

LGTM

@gotmax23
Copy link
Contributor

I added https://pypi.org/project/ansible/#reporting-issues earlier this year to make it clearer where to report issues, but I definitely like the idea of defining the scope of this repo's issue tracker specifically.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Maxwell G <maxwell@gtmx.me>
@felixfontein
Copy link
Contributor Author

I added https://pypi.org/project/ansible/#reporting-issues earlier this year to make it clearer where to report issues, but I definitely like the idea of defining the scope of this repo's issue tracker specifically.

I think we should also mention this repo's issue tracker in that paragraph.

README.md Outdated Show resolved Hide resolved
@gotmax23
Copy link
Contributor

I added https://pypi.org/project/ansible/#reporting-issues earlier this year to make it clearer where to report issues, but I definitely like the idea of defining the scope of this repo's issue tracker specifically.

I think we should also mention this repo's issue tracker in that paragraph.

I added a short blurb about the ansible-build-data tracker to the README in ansible-community/antsibull-build#554.

Co-authored-by: Maxwell G <maxwell@gtmx.me>
@mariolenz
Copy link
Collaborator

Is there anything open or can we merge?

Or should wait for more feedback?

@felixfontein
Copy link
Contributor Author

It's probably a good idea to see whether @oraNod and/or @samccann have any feedback on this tomorrow. It's probably a good idea to get this merged soon (similar to ansible-community/antsibull-build#554).

README.md Outdated Show resolved Hide resolved
Co-authored-by: Sandra McCann <samccann@redhat.com>
@felixfontein felixfontein merged commit c62d4f2 into ansible-community:main Nov 13, 2023
2 checks passed
@felixfontein felixfontein deleted the readme branch November 13, 2023 17:23
@felixfontein
Copy link
Contributor Author

@mariolenz @gotmax23 @samccann thanks for your reviews and improvements!

gotmax23 added a commit to ansible-community/antsibull-build that referenced this pull request Nov 22, 2023
* ansible-readme.rst: mention the ansible-build-data issue tracker

Ref: ansible-community/ansible-build-data#322 (comment)

* ansible-readme.rst: change link to ansible-build-data tracker
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.

4 participants