# Contributing to `pypulseq`
: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](#code-of-conduct)
2. [PEP Style Guide for Python coding](#style-guide-for-python-code)

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

## Pull requests
Follow the coding conventions laid out in the [Style Guide for Python Code](style_guide). Ensure source code is 
documented as per the Numpy convention [[numpy1]], [[numpy2]]. If you notice any `pypulseq` code not adhering to 
[PEP8](style-guide), 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.

[email]: mailto:imr.framework2018@gmail.com
[code_of_conduct]: https://github.com/imr-framework/pypulseq/blob/master/CODE_OF_CONDUCT.md
[style_guide]: https://www.python.org/dev/peps/pep-0008/
[numpy1]: https://numpydoc.readthedocs.io/en/latest/format.html
[numpy2]: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html