From f342243fb03523ddc021e6c34c633ce921a9eac5 Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Tue, 21 Sep 2021 12:16:28 +0200 Subject: [PATCH] Update README.md (#3402) (#3415) * Update README.md * Update README.md Co-authored-by: Felix Fontein * Fix the link Co-authored-by: Felix Fontein (cherry picked from commit e1cdad35373abfa3b32e37bd5bf17466dabe80c6) Co-authored-by: Andrew Klychkov --- README.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index beec2f33b4..8cbfd22440 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,21 @@ Also for some notes specific to this collection see [our CONTRIBUTING documentat See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#testing-collections). -### Communication +## Collection maintenance + +To learn how to maintain / become a maintainer of this collection, refer to: + +* [Committer guidelines](https://github.com/ansible-collections/community.general/blob/main/commit-rights.md). +* [Maintainer guidelines](https://github.com/ansible/community-docs/blob/main/maintaining.rst). + +It is necessary for maintainers of this collection to be subscribed to: + +* The collection itself (the `Watch` button → `All Activity` in the upper right corner of the repository's homepage). +* The "Changes Impacting Collection Contributors and Maintainers" [issue](https://github.com/ansible-collections/overview/issues/45). + +They also should be subscribed to Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn). + +## Communication We announce important development changes and releases through Ansible's [The Bullhorn newsletter](https://eepurl.com/gZmiEP). If you are a collection developer, be sure you are subscribed. @@ -86,16 +100,11 @@ We take part in the global quarterly [Ansible Contributor Summit](https://github For more information about communities, meetings and agendas see [Community Wiki](https://github.com/ansible/community/wiki/Community). -For more information about communication, refer to the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html). +For more information about communication, refer to Ansible's the [Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html). -### Publishing New Version +## Publishing New Version -Basic instructions without release branches: - -1. Create `changelogs/fragments/.yml` with `release_summary:` section (which must be a string, not a list). -2. Run `antsibull-changelog release --collection-flatmap yes` -3. Make sure `CHANGELOG.rst` and `changelogs/changelog.yaml` are added to git, and the deleted fragments have been removed. -4. Tag the commit with ``. Push changes and tag to the main repository. +See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/main/releasing_collections.rst) to learn how to release this collection. ## Release notes @@ -103,10 +112,10 @@ See the [changelog](https://github.com/ansible-collections/community.general/blo ## Roadmap -See [this issue](https://github.com/ansible-collections/community.general/issues/582) for information on releasing, versioning and deprecation. - In general, we plan to release a major version every six months, and minor versions every two months. Major versions can contain breaking changes, while minor versions only contain new features and bugfixes. +See [this issue](https://github.com/ansible-collections/community.general/issues/582) for information on releasing, versioning, and deprecation. + ## More information - [Ansible Collection overview](https://github.com/ansible-collections/overview)