Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the repository's README file to explicitly guide new users through the contribution process. It also introduces a pre-commit hook to black format and sort imports.
Pull request type
What is the current behavior?
It is currently a requirement that formatting be done manually by the user upon committing code. This can lead to incocistencies when people use different formatting options or forget to pre-format code.
Further, there is no acknowledgement to how new users can contribute to GPJax from with the repository's README.
Issue Number: #76
What is the new behavior?
A pre-commit hook is introduced to automate code formatting. A section of text has been introduced into the repository's README file to signpost new users to the relevant parts of the repository for contributing, raising issues, or starting discussions.