Template and check-list for projects

[niccokunzmann]

Putting packages into pycalendar, we want to provide a similar experience for people using those packages.
Also, it is good to have clarity on our responsibilities for the projects.

This includes

• clear licensing
• clear contribution guidelines & maintenance policy Defining (default) merge policies #4
• common code of conduct
• common AI policy
• What else, please comment

standard \ package	pycal.org	sphinx-icalendar	ics-query	ai-prompt-auto-commit	x-wr-timezone	ical2jcal	icalendar-anonymizer	icalendar-searcher	calendaring-client	calendaring-jmap	calendar-cli
license	-	MIN	MIN	MIN	MIN	MIN	MIN	MIN	-	-	-
AI policy link	MIN	-	-	-	-	-	-	-	-	-	-
maintenance policy	-	REC	REC	REC	REC	REC	-	-	-	-	-
contributing	-	REC	-	-	-	-	REC	-	-	-	-
Code of Conduct	-	-	-	-	-	-	-	-	-	-	-
Security Policy	-	-	-	-	MIN	-	-	-	-	-	-
pycal.org	MIN	MIN	MIN	-	MIN	MIN	MIN	MIN	MIN	MIN	MIN
code owners

---

license

MINIMAL:

• the license is in a LICENSE file
• the license is in the pyproject.toml as license id

RECOMMENDED:

• the license is on the docs page
• in the README
• the license is in the pyproject.toml as license-files

ai policy

A link to the pylcal.org AI policy is

MINIMAL:

• on the documentation website

RECOMMENDED:

• in the README

maintenance guideline

A policy is chosen for us internally to know who can contribute and how, see #4

MINIMAL:

• merge policy

RECOMMENDED:

• how to create a new release

contribution guideline

External contributors are guided on how to contribute and setup the project.

MINIMAL:

• CONTRIBUTING.md exists
• docs or CONTRIBUTING.md include
  • docs build
  • running tests

RECOMMENDED:

• where to report issues

Code of Conduct

MINIMAL:

link to pycal.org CoC pycalendar/pycal.org#26

• in docs

RECOMMEDED:

• in README

Security Policy

MINIMAL:

• SECURITY.md exists]
• describes which versions will receive security patches
• describes how to reach out to report a security incident

pycal.org

MINIMAL:

• project is listed on pycal.org https://github.com/pycalendar/pycal.org/blob/main/_data/packages.yml

Code owners

RECOMMENDED:

• a CODEOWNERS file to notify reviewers for PRs.

---

Way forward:

• create template files or repo if that helps
• add links to examples that fulfil the requirements
• create first-timer issue(s) for project migration

Please comment on what you recommend/require for packages

[niccokunzmann]

@stevepiercy @abe-101 @SashankBhamidi @tobixen, please watch this repository.

Also, I added maintenance policies for the projects I added. Feel free to co-maintain ;)

[stevepiercy]

For all of these files, I think we don't want to copy-pasta, but designate the authoritative file in a single location, whether that's at the root of the repo or a page on pycal.org, and reference that location from all other places. The way this topic is currently worded gives the impression that content would be copy-pasta spaghetti policy.

Of course, there may be exceptions, but those should be noted.

[tobixen]

My preference is to have a document for each project containing nothing but a link to the authoritative team-wise policy.

(if needed, said document may also contain special unicorn rules for exactly that project).

[SashankBhamidi]

I prefer having a standalone page under pycal.org that can be used to refer elsewhere

[stevepiercy]

I prefer having a standalone page under pycal.org that can be used to refer elsewhere

Do you mean "a standalone page under pycal.org which is referred from elsewhere"?

[SashankBhamidi]

Yes, precisely.

[stevepiercy]

My preference is to have a document for each project containing othing but a link to the authoritative team-wise policy.

Yup. Like this:

• https://github.com/collective/icalendar/blob/main/CODE_OF_CONDUCT.md