Contributing guidelines

[wd60622]

Adding some information about how to contributing to PyPika after the conversation in this Issue.

I've added a CONTRIBUTING document that will be linked in the docs that build (where do these update by the way?)
Any feedback on content would be helpful!

I just added a few items based on setting up the environment and running tests but this is very flexible.

Does anyone know how to have a checklist added to a new PR via a GitHub action? Maybe a checklist or a link to this documentation would be reminder if the automation is easy to setup

Overall, I hope this helps standardize some of the steps while contributing.

[AzisK]

Nice work, thank you!

I have one question. docs/index.rst is not displayed well as an rst file via Github platform but I suppose it looks well when opening in the browser?

[coveralls]

coverage: 98.387%. remained the same when pulling 179aa95 on wd60622:contributing into ded17eb on kayak:master.

[wd60622]

Nice work, thank you!

I have one questions. docs/index.rst is not displayed well as an rst file via Github platform but I suppose it looks well when opening in the browser?

Correct. Here is the preview from local build. I'm not a sphinx expert with references other pages but it seems to be working

[wd60622]

Is there a build script that runs upon merge to main?

[AzisK]

I believe that everything that runs is described here in the workflows https://github.com/kayak/pypika/tree/master/.github/workflows. Only a linting process and a testing process in various Python versions is done

[wd60622]

I believe that everything that runs is described here in the workflows https://github.com/kayak/pypika/tree/master/.github/workflows. Only a linting process and a testing process in various Python versions is done

Thats what I made of it too.

Are the docs build manual then?

[AzisK]

It seems to be so currently

[wd60622]

It seems to be so currently

Confirmed here
https://readthedocs.org/projects/pypika/builds/

[wd60622]

I've added a bit more to the CONTRIBUTING.rst as well as added support for numpy style docstrings (raised by me)

I have successful builds locally but with handful of warnings:

WARNING: toctree contains reference to nonexisting document 'api/pypika.terms.WindowFrameAnalyticFunction.wrap_constant'

[wd60622]

Ended up adding the missing modules (but didn't explore clickhouse) and checking an example of numpydoc style with in the Query class

[AzisK]

Looks good