Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 2.17 KB

CONTRIBUTING.rst

File metadata and controls

52 lines (35 loc) · 2.17 KB
Raw

Contributing to pyGeoMag

Notes

  1. This is a direct port from the Legacy C code provided by NOAA.
  2. It defaults to using the WMM-2020 Coefficient file (WMM.COF) valid for 2020.0 - 2025.0.
  3. The code is specifically not 100% pythonic in order to make adding updates simple (for example uppercase variable names).
  4. It has been written to work in both MicroPython and CircuitPython and the fact that these do not have the full standard Python library.

Reporting issues

If you find an issue, catch an exception, or find any other problems, please:

  1. Look for or start a GitHub Discussions.
  2. Once a bug has been validated, open a GitHub Issue. Please don't open one until it's been verified.

Pull requests

  1. Please do not open a Pull request without starting a GitHub Discussions first. This repository is actively being worked on, and do not want to create wasted work
  2. Please do not try to make it more pythonic as it's built to match the original C code
  3. If you do create a pull request, please make sure that:
    1. All tests pass (you will need to run pip install -r requirements-test.txt)
      1. pytest --cov --xdoctest
    2. Code coverage for the changes is at 100%
      1. python -m coverage report to view in the console or
      2. python -m coverage html to build out html files to look at what's missing
    3. Documentation builds without errors (you will need to run pip install -r docs/requirements.txt)
      1. sphinx-build -W -b html docs/ docs/build/html
    4. Make sure that the code can be compiles with mpy-cross (there is a good guide on setting that up here
    5. Make sure the project builds (you will need to run pip install -r requirements-build.txt)
      1. python -m build
    6. You follow the current coding styles