Document Setup process for development

[niccokunzmann]

This pull request aims at clarifying how to setup icalendar for development.

[mister-roboto]

@niccokunzmann thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

[niccokunzmann]

@jenkins-plone-org please run jobs

[niccokunzmann]

So, I see this:

Plone Jenkins CI - pull-request-6.0-3.7:

Setup failed:
WebDriverException: Message: unknown error: Chrome failed to start: exited abnormally.
  (unknown error: DevToolsActivePort file doesn't exist)
  (The process started from chrome location /usr/bin/chromium-browser is no longer running, so ChromeDriver is assuming that Chrome has crashed.)

Much more in Plone Jenkins CI - pull-request-5.2-3.6.

Is there some explanation for this? Why are all these tests running? Where can I read more about this?
There is probably some plone documentation...

[mauritsvanrees]

We should probably disable Jenkins tests for this package. We would need a replacement though. Last year I tried but failed to add GitHub actions.

I have created a post on the Plone community forum about the future of this package, and needing a maintainer for it.

[geier]

We have set up GitHub actions for running tests for khal (which heavily relies on icalendar), I can give it a go.

[mauritsvanrees]

Actually, let me open op discussions in this repository: #360

[mauritsvanrees]

We have set up GitHub actions for running tests for khal (which heavily relies on icalendar), I can give it a go.

Thanks, that would be very welcome. I know enough about tox and GitHub actions, but haven't spent enough time improving it for this repo. There may be some very basic things amiss in the tox setup.

If you open a PR for that, please ping or assign me and I can have a look. I was not even watching this repo with notifications until just now.

And since you are the number three contributor to this package, you would be a prime candidate to be a new maintainer, if you want. :-)

[coveralls]

Pull Request Test Coverage Report for Build 2814204215

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 90.758%

---

Totals
Change from base Build 2684673460:	0.0%
Covered Lines:	1149
Relevant Lines:	1266

---

💛 - Coveralls

[mauritsvanrees]

LGTM, thanks.