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.

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

Added section to CONTRIBUTING

parent 5fb291b5
......@@ -3,6 +3,17 @@ Contributing
Before submitting pull requests please make sure your code complies with the following.
Git etiquette
-------------
If you're planning on adding a feature (new function or class) then create your own branch,
```bash
git checkout -b my_new_feature
```
and start commiting there to test and work on. We will follow a [trunk-based development model](https://youtu.be/ykZbBD-CmP8). This means we will rapidly merge branches once you have something stable and continue with master branch. So make sure to push something stable instead of being in your feature branch for too long. I will try to address your pull request ASAP.
Coding Style: PEP 8
-------------------
......@@ -54,6 +65,7 @@ def func_with_dependency():
Depends on spacepy. Try `pip install -U spacepy`
"""
import spacepy
# Function body
```
......
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