Update contribution documentation #329
Conversation
Updated documentation for contributing to reflect the change to using Poetry for dependency management. Also added the command for manually running the pre-commit hook to the documentation. Also fixed a few broken links and typos I had encountered.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Thank you for opening your first PR into GPJax!
If you have not heard from us in a while, please feel free to ping @gpjax/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on Slack for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
|
@thomaspinder tagging for review as I'm unable to add you as a reviewer. |
There was a problem hiding this comment.
Looks great @Thomas-Christie. Just a small comment from me re. users with M1 chips; a topic we've received several questions about.
Added suggestion to use Conda miniforge for users wishing to run GPJax on Apple Silicon. Co-authored-by: Thomas Pinder <tompinder@live.co.uk> Signed-off-by: Thomas Christie <thomashamish@hotmail.com>
|
Thanks for the review @thomaspinder, I have added the change you suggested. |
|
Great work @Thomas-Christie. You can merge this now. |
Updated documentation for contributing to reflect the change to using Poetry for dependency management. Also added the command for manually running the pre-commit hook to the documentation.
Also fixed a few broken links and typos I had encountered.
Type of changes
Checklist
poetry run pre-commit run --all-files --show-diff-on-failurebefore committing.Description
Poetry is now used for dependency management, but the documentation for contributing hadn't been updated to reflect this. Therefore, the documentation for contributing has been updated to reflect this change. A few broken links and typos have also been fixed.
Issue Number: N/A