Commit d07a7045 authored by Qusai Al Shidi's avatar Qusai Al Shidi 💬
Browse files

Added contributing

parent fa37f91a
Before submitting pull requests please make sure your code complies with the following.
Coding Style: PEP 8
The style for your code must follow the [PEP 8]( style guide. It would be helpful to use a linter like [pylint]( to check whether your code is complying before submitting.
Coding Standard
Please write readable code. Make sure your function names well describes your functions. Always include docstrings that use the [Google coding style]( The Google coding style guide is a good document to follow so I recommend reading it.
If your code has dependencies that is large and uncommon (e.g. SpacePy) then please seperate it as it's own module. For example you may create a folder:
mkdir swmfpy/spacepy
touch swmfpy/
Then your functions will be in swmfpy.spacepy which has its own namespace.
If you want to create a new module make sure what you're trying to do can't just fit in the modules already made.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment