Contributing

Contributions are welcomed and greatly appreciated.

Bugs Reports/Feedback

Report bugs or give feedback by filing an issue at https://github.com/derb12/mcetl/issues.

If you are reporting a bug, please include:

• Your operating system, Python version, and mcetl version.

• Any further details about your local setup that might be helpful in troubleshooting.

• Detailed steps to reproduce/identify the bug, including the code used and any tracebacks.

If you are proposing a feature:

• Explain in detail how it would work.

• Keep the scope as narrow as possible to make it easier to implement.

Pull Requests

Pull requests are welcomed for this project, but please note that unsolicited pull requests are discouraged. Please file an issue first, so that details can be discussed/finalized before a pull request is created.

Any new code or documentation must be unique (not copied from somewhere else) and able to be covered by the BSD 3-clause license. Further, any new code should follow PEP 8 standards as closely as possible and be fully documented using Numpy style docstrings. If implementing a new feature, please provide documentation discussing its implementation, and any necessary tests.

To clone the GitHub repository and install the needed libraries for development:

git clone https://github.com/derb12/mcetl.git
pip -r install mcetl/requirements/requirements-development.txt

When submitting a pull request, follow similar procedures for a feature request, namely:

• Explain in detail how it works.

• Keep the scope as narrow as possible to make it easier to incorporate.