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.

Sign up for GitHub

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

Jump to bottom

Update README with better testing instructions and doc guide #551

Closed
keithf4 opened this issue Aug 9, 2023 · 2 comments
Closed

Update README with better testing instructions and doc guide #551

keithf4 opened this issue Aug 9, 2023 · 2 comments
Labels
documentation fixed in next release
Milestone
5.1

Comments

@keithf4
Copy link
Collaborator

keithf4 commented Aug 9, 2023 •
edited
Loading

After 5.0 is out, see about providing better instructions in the README for how to use pgtap to do unit tests on pg_partman

Create a table/something with better clarity on what the different files in the doc folder are for

Request came from this PR #547
@keithf4 keithf4 added this to the 5.1 milestone Aug 9, 2023
@keithf4 keithf4 changed the title Update README with better testing instructions Update README with better testing instructions and doc guide Aug 9, 2023
@keithf4
Copy link
Collaborator Author

keithf4 commented Aug 10, 2023

Note that additional instructions for using pgTAP are contained in the README file in the test folder. Did update it a bit for 5.x and provided further guidance on how to get pg_prove if it didn't come with pgtap.

@keithf4
Copy link
Collaborator Author

keithf4 commented Aug 16, 2023

Updated top level readme with a table describing documentation

@keithf4 keithf4 closed this as completed Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation fixed in next release
Projects
None yet
Milestone
5.1
Development

No branches or pull requests
1 participant
@keithf4