Skip to content

Commit

Permalink
rename contributor to collaborator
Browse files Browse the repository at this point in the history
  • Loading branch information
niccokunzmann committed Nov 14, 2023
1 parent ce0de32 commit b8be625
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 19 deletions.
2 changes: 2 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- ...
Expand Down
39 changes: 20 additions & 19 deletions docs/maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -44,22 +49,22 @@ 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 <https://pypi.org/project/icalendar/>`_.

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.


1. Check that the ``CHANGES.rst`` is up to date with the `latest merged pull requests <https://github.com/collective/icalendar/pulls?q=is%3Apr+is%3Amerged>`__
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.

Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -147,7 +152,3 @@ This section contains useful links for maintainers and contributors:

- `Future of icalendar, looking for maintainer #360 <https://github.com/collective/icalendar/discussions/360>`__
- `Comment on the Plone tests running with icalendar <https://github.com/collective/icalendar/pull/447#issuecomment-1277643634>`__




0 comments on commit b8be625

Please sign in to comment.