Note: The default ITS GitLab runner is a shared resource and is subject to slowdowns during heavy usage.
You can run your own GitLab runner that is dedicated just to your group if you need to avoid processing delays.

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

Fixed up `CONTRIBUTING.markdown` to be better and added issues guidelines

parent 95490269
Contributing
============
Contributing Issues
===================
To submit an [issue](https://gitlab.umich.edu/swmf_software/swmfpy/issues) please make sure to be very specific on the trouble you are having. If your issue is a bug make sure to paste this in your text and add to it as necessary:
- Problem:
- Error text:
- How to reproduce the error:
- Computer specs:
Once you fill out those you are ready to [submit an issue](https://gitlab.umich.edu/swmf_software/swmfpy/issues).
If your issue is a task or feature request, fill this out:
- Feature or task:
- Benefits:
- Where to start:
If you fill out those you are ready to [submit an issue](https://gitlab.umich.edu/swmf_software/swmfpy/issues).
Contributing Code
=================
Before submitting pull requests please make sure your code complies with the following.
......@@ -59,19 +79,11 @@ def my_new_func(some_args):
Dependencies
------------
If your code has dependencies that is large and uncommon (e.g. SpacePy) then please import it in the function and be explicit about the dependencies. For example you may create a function:
If your code has dependencies that is large and uncommon (e.g. `tecplot`) then please import it in a new module.
```python
def func_with_dependency():
"""Func does this.
Depends on spacepy. Try `pip install -U spacepy`
"""
import spacepy
# Function body
```
Then your functions will be in `swmfpy.tecplot` which has its own namespace.
Then your functions will be in swmfpy.spacepy which has its own namespace.
If it's a well known easy to find software like, for example, `spacepy` then we can discuss in a merge request whether swmfpy should depend on such module. Usually the answer is yes as `pip` does its job well :).
Modules
-------
......
......@@ -12,14 +12,9 @@ Installation
Clone into the directory you want to use it.
*Note*: swmfpy also is part of the SWMF and gets cloned into `SWMF/share/Python`. However, if you would like to [develop](CONTRIBUTING.markdown) for swmfpy or have a local copy do the following:
*Note*: swmfpy also is part of the SWMF and gets cloned into `SWMF/share/Python`. However, if you would like to [develop](CONTRIBUTING.markdown) for swmfpy make a clone and work that way and make a merge request.
```shell
# Skip this if using it in SWMF directory.
$ git clone https://gitlab.umich.edu/swmf_sofware/swmfpy.git /path/to/my/dir
```
Then install with [pip](https://pip.pypa.io/en/stable/):
Install with [pip](https://pip.pypa.io/en/stable/):
```shell
$ python3 -m pip install --user wheel # Might be necessary
......
Markdown is supported
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