Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# CODEOWNERS file for automatic PR review assignment
# See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

# Default owners
* @niccokunzmann @stevepiercy

# Documentation, except docstrings in `src`
*.md @stevepiercy @abe-101
*.rst @stevepiercy @abe-101
/.readthedocs.yml @stevepiercy @niccokunzmann @abe-101
/.vale.ini @stevepiercy @abe-101
/CONTRIBUTING.md @niccokunzmann @stevepiercy @abe-101
/docs/ @stevepiercy @abe-101
/Makefile @stevepiercy @abe-101
/styles @stevepiercy @abe-101

# Core calendar logic
/src/ @niccokunzmann @SashankBhamidi @stevepiercy @angatha

# Tests
/src/icalendar/tests/ @niccokunzmann @SashankBhamidi

# Fuzzing
/src/icalendar/fuzzing/ @ennamarie19 @niccokunzmann @SashankBhamidi

# CI and infrastructure
/.coveragerc @niccokunzmann
/.github/ @niccokunzmann @SashankBhamidi @stevepiercy
/.pre-commit-config.yaml @niccokunzmann @SashankBhamidi @stevepiercy
/bootstrap.py @niccokunzmann @stevepiercy
/buildout.cfg @niccokunzmann @stevepiercy
/pyproject.toml @niccokunzmann @stevepiercy
/tox.ini @niccokunzmann @stevepiercy

# Security
/SECURITY.md @niccokunzmann @stevepiercy @abe-101 @angatha

# Release stuff
/CHANGES.rst @niccokunzmann @stevepiercy
/MANIFEST.in @niccokunzmann
3 changes: 2 additions & 1 deletion CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ Minor changes:
- Document ``icalendar.version`` module.
- Use ``CONTRIBUTING.md`` in favour of ``.rst`` file.
- Add type hints to ``icalendar.tools`` module.
- Fix more examples link failed in ``README.md`` by renewing its link. See `Issue 958 <https://github.com/collective/icalendar/issues/958>`_.
- Fix more examples link in ``README.md``. See `Issue 958 <https://github.com/collective/icalendar/issues/958>`_.
- Add ``CODEOWNERS`` file for automatic pull request review assignment. See `Issue 945 <https://github.com/collective/icalendar/issues/945>`_.

Breaking changes:

Expand Down
38 changes: 26 additions & 12 deletions docs/contribute/maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,16 @@ Currently the maintainers are the following people.

Maintainers need the following permissions.

- ``Admin`` access to the `repository <https://github.com/collective/icalendar>`_.
``Admin`` access to the `repository <https://github.com/collective/icalendar>`_.
These can be enabled by a current maintainer or a GitHub organization administrator in the `settings <https://github.com/collective/icalendar/settings/access>`_.
- ``Maintainer`` or ``Owner`` access to the `PyPI project <https://pypi.org/project/icalendar/>`_.
``Maintainer`` or ``Owner`` access to the `PyPI project <https://pypi.org/project/icalendar/>`_.
Each owner and maintainer needs a PyPI account.
All PyPI accounts require two-factor authentication (2FA) enabled.
Owners can invite either new owners or maintainers in the `collaboration Section <https://pypi.org/manage/project/icalendar/collaboration/>`_ on PyPI.
- ``Maintainer`` access to the `Read the Docs project <https://app.readthedocs.org/projects/icalendar/>`_.
``Maintainer`` access to the `Read the Docs project <https://app.readthedocs.org/projects/icalendar/>`_.
Existing maintainers can invite another maintainer through the `Maintainers <https://app.readthedocs.org/dashboard/icalendar/users/create/>`_ page.
- ``Environments/Configure PyPI`` access for GitHub Workflows to grant new releases from tags.
Organization owners and repository administrators can grant this access in `Settings → Environments → PyPI <https://github.com/collective/icalendar/settings/environments/674266024/edit>`_
by adding the GitHub username to the list of :guilabel:`Required Reviewers`.
``Environments/Configure PyPI`` access for GitHub Workflows to grant new releases from tags.
Organization owners and repository administrators can grant this access in :menuselection:`Settings --> Environments --> PyPI`, or at https://github.com/collective/icalendar/settings/environments/674266024/edit, by adding their GitHub username to the list of :guilabel:`Required Reviewers`.


Collaborators
Expand All @@ -34,21 +33,36 @@ Collaborators
Collaborators have write access to the repository.
As a collaborator, you can

- merge pull requests, and
- initiate a new release.
- merge pull requests,
- initiate a new release, and
- become a :ref:`code-owner`.

The maintainers of icalendar 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
- better code review
- lower bus factor and backup
- future maintainers
- a constant flow of fixes and new features
- better code review
- lower bus factor and backup
- future maintainers

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 to become a collaborator.
A maintainer may ask if you would like to become one.


.. _code-owner:

Code owner
----------

A code owner is a type of collaborator or maintainer who is responsible for a specific part of the code.
Code owners are automatically requested for review when someone opens a pull request that modifies code that they own.

You may ask, or be invited, to become a code owner as part of becoming a collaborator or maintainer.
When doing so, you or the inviter may submit a pull request to update the :file:`.github/CODEOWNERS` file.

.. seealso:: `About code owners <https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners>`_


New releases
------------

Expand Down
1 change: 1 addition & 0 deletions docs/styles/config/vocabularies/Base/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
inviter
Loading