From b8be6256a94f986786ba3028db58ff5e0d85cc4a Mon Sep 17 00:00:00 2001 From: Nicco Kunzmann Date: Tue, 14 Nov 2023 15:16:13 +0000 Subject: [PATCH 1/2] rename contributor to collaborator --- CHANGES.rst | 2 ++ docs/maintenance.rst | 39 ++++++++++++++++++++------------------- 2 files changed, 22 insertions(+), 19 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 3fce2639..2b0bc834 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -11,6 +11,8 @@ Minor changes: - Augmented fuzzer to optionally convert multiple calendars from a source string - Added additional exception handling of defined errors to fuzzer, to allow fuzzer to explore deeper - Added more instrumentation to fuzz-harness +- Rename "contributor" to "collaborator" in documentation + Breaking changes: - ... diff --git a/docs/maintenance.rst b/docs/maintenance.rst index e81e72d1..43f96cd4 100644 --- a/docs/maintenance.rst +++ b/docs/maintenance.rst @@ -31,10 +31,15 @@ Maintainers need this: by adding the GitHub username to the list of "Required Reviewers". -Contributors ------------- +Collaborators +------------- + +Collaborators are people with write access to the repository. +As a collaborator, you can + +- merge Pull Requests, +- initiate a new release, see below. -Contributors here are people with write access to the repository. We want to have as many knowledgeable people with write access taking responsibility as possible for these reasons: - a constant flow of fixes and new features @@ -44,14 +49,14 @@ We want to have as many knowledgeable people with write access taking responsibi Nobody should merge their own pull requests. If you like to review or merge pull requests of other people and you have shown that you know how to contribute, -you can ask for becoming a contributor or a maintainer asks you if you would like to become one. +you can ask for becoming a collaborator or a maintainer asks you if you would like to become one. New Releases ------------ This explains how to create a new release on `PyPI `_. -Since contributors and maintainers have write access the the repository, they can start the release process. +Since collaborators and maintainers have write access the the repository, they can start the release process. However, only people with ``PyPI environment access for GitHub Actions`` can approve an automated release to PyPI. @@ -59,7 +64,7 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app and the version you want to release is correctly named. 2. Change the ``__version__`` variable in - - the ``src/icalendar/__init__.py`` file and + - the ``src/icalendar/__init__.py`` file and - in the ``docs/install.rst`` file (look for ``icalendar.__version__``) 3. Create a commit on the ``release`` branch (or equivalent) to release this version. @@ -111,21 +116,21 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app 5.0.2 (unreleased) ------------------ - + Minor changes: - + - ... - + Breaking changes: - + - ... - + New features: - + - ... - + Bug fixes: - + - ... 11. Push the new CHANGELOG so it is used for future changes. @@ -136,7 +141,7 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app git pull git add CHANGES.rst git commit -m"Add new CHANGELOG section for future release - + See https://icalendar.readthedocs.io/en/latest/maintenance.html#new-releases" git push upstream master # could be origin or whatever reference @@ -147,7 +152,3 @@ This section contains useful links for maintainers and contributors: - `Future of icalendar, looking for maintainer #360 `__ - `Comment on the Plone tests running with icalendar `__ - - - - From 12fc882c9fcf6a6388aae4f23e21b6525941f910 Mon Sep 17 00:00:00 2001 From: angatha <59320234+angatha@users.noreply.github.com> Date: Wed, 15 Nov 2023 18:56:21 +0100 Subject: [PATCH 2/2] Replace contributors with collaborators in Links section --- docs/maintenance.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintenance.rst b/docs/maintenance.rst index 43f96cd4..7b8f33c7 100644 --- a/docs/maintenance.rst +++ b/docs/maintenance.rst @@ -148,7 +148,7 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app Links ----- -This section contains useful links for maintainers and contributors: +This section contains useful links for maintainers and collaborators: - `Future of icalendar, looking for maintainer #360 `__ - `Comment on the Plone tests running with icalendar `__