Skip to content

Commit

Permalink
README: clarify what the issue tracker covers (#322)
Browse files Browse the repository at this point in the history
* Clarify what the issue tracker covers.

* Mention adding, renaming, and removing of collections.

* Improve formulation.

Co-authored-by: Maxwell G <[email protected]>

* Improve formulations.

Co-authored-by: Maxwell G <[email protected]>

* Fix typo

Co-authored-by: Sandra McCann <[email protected]>

---------

Co-authored-by: Maxwell G <[email protected]>
Co-authored-by: Mario Lenz <[email protected]>
Co-authored-by: Sandra McCann <[email protected]>
  • Loading branch information
4 people authored Nov 13, 2023
1 parent 45b4a1f commit c62d4f2
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@
Holds generated but persistent results from building the `ansible` community package. This information
may be referred to by other projects and scripts.

## Issue tracker

[This repository's issue tracker](https://github.com/ansible-community/ansible-build-data/issues) handles various aspects of the `ansible` build, including:

1. Tracking release dates,
1. Tracking blockers for a release,
1. Tracking adding, renaming, and removing collections,
1. Tracking problems with a release related to the build process:
- This includes problems that prevent the package to be installed or system packages to be built from the PyPI release;
1. Tracking and discussing other problems with the `ansible` community package:
- This includes important problems with the included collections that are not acted on by the collection maintainers, for example largescale incompatibilities with the current ansible-core version, violations of semantic versioning, and general violations of the [Ansible inclusion requirements](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_requirements.html);
- This includes major or security bugs in collections with wide-reaching consequences that are not addressed by the collection maintainers, or cannot be addressed on the collection level for some reason.

This issue tracker is **not** for tracking regular bugs or feature requests for `ansible-core` or the collections included in the `ansible` package or for user support. **Such issues will be closed.** Instead, check out the [`ansible-core` issue tracker](https://github.com/ansible/ansible), issue trackers of the respective collections, or consider [asking for help in the Ansible forum](https://forum.ansible.com/).

## Milestones

Release engineers check the [milestones](https://github.com/ansible-community/ansible-build-data/milestones) for corresponding releases some time before releasing the package sufficient to solve all related issues.
Expand Down

0 comments on commit c62d4f2

Please sign in to comment.