Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul contributing documentation for Plone 6 #539

Merged
merged 13 commits into from
Jul 23, 2024

Conversation

stevepiercy
Copy link
Contributor

@stevepiercy stevepiercy commented Jul 20, 2024

Now that we have Plone core contributing documentation, I've simplified and modernized the contributing documentation.

See plone/documentation#1278.

After merging, then merge plone/documentation#1684.

@mister-roboto
Copy link

@stevepiercy 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!

@stevepiercy stevepiercy self-assigned this Jul 20, 2024
@stevepiercy
Copy link
Contributor Author

@jenkins-plone-org please run jobs

@stevepiercy
Copy link
Contributor Author

I have no clue as to why Jenkins fails for Plone 6.0/Python 3.11 but not for Plone 6.0/Python 3.8. Help!

Copy link
Member

@ksuess ksuess left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I appreciate your overhaul. Just minor suggestions to content that was already there before this PR.

docs/contribute.md Outdated Show resolved Hide resolved
docs/contribute.md Outdated Show resolved Hide resolved
Copy link
Sponsor Member

@jensens jensens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! Minor things see comments.

docs/contribute.md Outdated Show resolved Hide resolved
docs/contribute.md Outdated Show resolved Hide resolved
@stevepiercy
Copy link
Contributor Author

@jenkins-plone-org please run jobs

@stevepiercy stevepiercy requested a review from ksuess July 22, 2024 21:16
@stevepiercy
Copy link
Contributor Author

Changes made, and I excluded GNU make as a requirement here since this project uses tox instead.

It would be nice to use one of make or tox for all of Plone, don't you think?

@ksuess
Copy link
Member

ksuess commented Jul 23, 2024

It would be nice to use one of make or tox for all of Plone, don't you think?

Yes, a switch to make would be consistent. Definitly.

@stevepiercy stevepiercy merged commit dcde26b into master Jul 23, 2024
17 checks passed
@stevepiercy stevepiercy deleted the contributing-plone-6 branch July 23, 2024 10:10
@stevepiercy
Copy link
Contributor Author

It would be nice to use one of make or tox for all of Plone, don't you think?

Yes, a switch to make would be consistent. Definitly.

See https://community.plone.org/t/tools-for-development-gnu-make-tox-or/19708

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

Replace Netlify preview build command with 'tox -e docs' and remove Makefile Update contribution docs
4 participants