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

Document steps to contribute that are specific to plone.restapi #1664

Closed
stevepiercy opened this issue Jul 5, 2023 · 2 comments
Closed

Document steps to contribute that are specific to plone.restapi #1664

stevepiercy opened this issue Jul 5, 2023 · 2 comments

Comments

@stevepiercy
Copy link
Contributor

But ideally, you have black installed locally, and format the code before committing. You can install it by running the make command inside the plone.restapi folder. After running make, you can run make black. This will automatically format the code for you. Some IDEs also have integration with black, to format the code when saving.

The make command will also install all of the package's dependencies. Then you can run the tests locally, with the command make test.

This should go into the documentation: https://6.docs.plone.org/plone.restapi/docs/source/contributing/index.html. It's not in the README. At the very least, an output of the make help command would be good.

Originally posted by @stevepiercy in #1655 (comment)

@Akshat2Jain
Copy link
Member

@stevepiercy, Why this issue is still open?

@davisagli
Copy link
Member

@Akshat2Jain I'll close it now. In order for github to close it automatically when the PR is merged, the PR description needs to say "Fixes #1664" or "Closes #1664"

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

No branches or pull requests

3 participants