Contributing to pypulseq

August 5, 2020 ยท View on GitHub

:thumbsup: :tada: Thanks for taking time to contribute! :thumbsup: :tada:

Here are guidelines (not rules!) for contributing to pypulseq. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of contents

  1. Code of Conduct
  2. PEP Style Guide for Python coding

Code of Conduct

This project and everyone participating in it is governed by the pypulseq Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to imr.framework2018@gmail.com.

Pull requests

Follow the coding conventions laid out in the Style Guide for Python Code. Ensure source code is documented as per the Numpy convention [numpy1], [numpy2]. If you notice any pypulseq code not adhering to PEP8, submit a pull request or open an issue.

Issues

Please adhere to the appropriate templates when reporting bugs or requesting features. The templates are automatically presented via Github's 'New Issue' feature.