search

plone / plone.restapi

RESTful API for Plone.
http://plonerestapi.readthedocs.org/
84 stars 73 forks source link

Add Documentation for Code Formatting and Testing #1667

Closed Akshat2Jain closed 12 months ago

Akshat2Jain commented 1 year ago

Description

This pull request adds documentation for code formatting and testing in the plone.restapi project.

The documentation includes instructions on installing the "black" tool for code formatting, using the make command to install project dependencies, and running tests locally.

This pr is related to #1664

netlify[bot] commented 1 year ago

Deploy Preview for plone-restapi canceled.

Name Link
Latest commit 3c564a7880be9a3e05393fcc727f80e42fa42d74
Latest deploy log https://app.netlify.com/sites/plone-restapi/deploys/64aee52c9736f70008abd306
mister-roboto commented 1 year ago

@Akshat2Jain 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 commented 1 year ago

I requested a review from a couple of core maintainers, even though this is only a docs change. We don't need to run Jenkins for this. Here's a preview of the changes on Netlify: https://deploy-preview-1667--plone-restapi.netlify.app/contributing/index.html