Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

22 lines (15 loc) · 2.94 KB
Raw

Contributing

Thank you for considering a contribution to Pulse Pal!

How to contribute

  1. Make a fork of the develop branch of PulsePal.
  2. Clone your fork to create a local copy of it on your machine.
  3. Make any updates or additions to the docs, and commit the changes to your fork.
  4. Push your updated local fork to its remote location on Github.
  5. Create a pull request for us to integrate your changes into the project.

Style Guidelines

PulsePal aspires to comply with best practices as specified in Richard Johnson's MATLAB Style Guidelines 2.0 for MATLAB code, and with PEP8 for Python. We recognize that neuroscience researchers are often beyond busy with research, and we do not want contributions to our tools be hindered in any way. If you are time constrained, please ensure that your contributed code works as intended, and we will make any necessary style edits on our part before the next stable release.

  • Note: If you have access to OpenAI's ChatGPT-4 or equivalent, much of the heavy lifting for style compliance can be achieved with a simple prompt (e.g. for MATLAB): Please format the following MATLAB code to comply with with Richard Johnson's MATLAB Style Guidelines 2.0:, followed by your code. The output must be validated, keeping in mind that large language models occasionally hallucinate. Also, any formatting of user-facing function names, method names or property names must be reverted or handled to preserve backwards compatibility with existing behavior protocol code.

Important Notes About Contributing

  • We request that all contributions comply with the terms specified in CODE_OF_CONDUCT.md in this folder.

  • The master branch of PulsePal contains the latest stable release. We kindly request that you submit your pull request against the 'develop' branch of PulsePal, so that we can test the code before it is added to the default software for everyone. Pull requests made against 'master' will be closed, with a request to resubmit against 'develop'. Thank you!

  • We deeply appreciate the time and effort you have invested in your contribution! Please take a moment to reach out to us at [email protected], so that our core dev team can personally thank you for being a contributing member of the Pulse Pal community!