Skip to content

Commit

Permalink
Update content/pages/maintainers.md
Browse files Browse the repository at this point in the history
Co-authored-by: Martin Thoma <[email protected]>
  • Loading branch information
2 people authored and Cimon Lucas (LCM) committed May 15, 2023
1 parent 3ac45d1 commit 2003f2e
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 15 deletions.
13 changes: 0 additions & 13 deletions content/about-py-pdf-org.md

This file was deleted.

34 changes: 33 additions & 1 deletion content/pages/maintainers.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,42 @@ whether it is a bugfix or a feature request, your best options for achieving wha

To all [@py-pdf](https://github.com/py-pdf) members, remember: [it's okay to hit pause](https://opensource.guide/best-practices/#its-okay-to-hit-pause), and take time away from volunteer open-source work.

<br>

## Governance
**Redaction in progress...**
`py-pdf` governance model is descibed there:
<https://pypdf.readthedocs.io/en/latest/meta/project-governance.html>

<br>


### The relationship of py-pdf to its projects

`py-pdf` wants to ensure the Python-PDF ecosystem is prospering. We recognize that individual
maintainers did and still do an outstanding job, but we also see that personal lives sometimes
move away from software projects.

That means:

1. `py-pdf` offers the platform to exchange ideas and provide feedback
2. `py-pdf` administrators who are not project members do interfere, when (a) no activity by the maintainers is in the project for at least 6 months and at least 3 friendly "are you alive" questions over at least 6 weeks. (b) security issues are detected
3. `py-pdf` leaves the projects do their thing in all other cases.

### Conditions for projects to be added to py-pdf

We want projects which provide value to users and we need to be able to maintain them. We want to improve the Python / PDF ecosystem and not scatter it.

1. The project has to be a Python project and about PDF documents
2. If it's a software project, it has (1) a README with the projects purpose, installation instructions, and a usage example (2) at least 30% line coverage (3) it's either the main project or the fork that has more popularity measured in GitHub stars
3. It either has a different purpose than all other projects in `py-pdf` or is more popular than the existing projects for that purpose
4. It needs to be a FOSS license (e.g. BSD, MIT, Apache)

### Responsibility of project maintainers

1. **Software Reliability**: Please ensure that your project follows best practices in software development. Introduce a [deprecation process](https://pypdf.readthedocs.io/en/latest/dev/deprecations.html) and follow it.
2. **Kindness**: We are all here because it's fun to help others and create good software. But we are humans: People can have bad days and people might not speak English as a mother tongue. When in doubt, assume the best. Let people know how you perceived their interaction.
3. **Know your Limits**: It's ok to reduce the time you spend on your project or even step away from it. Stay healthy.
4. **Let your Project Grow**: Especially if you step away, let others take over. Make it explicit that you're looking for another person who would take over.
It's OK to [say no](https://opensource.guide/best-practices/#learning-to-say-no)

<!--
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Title: Rules for py-pdf owners
Date: 2023-04-18 17:10
Modified: 2023-04-18 17:10
Category: py-pdf
Tags: Governance
Slug: py-pdf-owners
Authors: Martin Thoma
Expand Down

0 comments on commit 2003f2e

Please sign in to comment.