Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

47 lines (27 loc) · 1.63 KB
Raw

How to contribute to ExoJAX

Branch model and pull-request (PR)

We adopt a simple git-flow model, consisting of master, develop, contributor-defined, and release branches. PR by contributors via a folked repository is always welcome.

  • master: stable branch. Once a set of functions is implemented in the develop branch, the maintainer (@HajimeKawahara) will merge them to the master branch through the release process (release branch).

  • develop: default branch for developers. PR by contributors will be merged to this branch, after the review process.

  • contributor-defined branches: The contirbutors make their own branch originated from the develop branch and after developing, we send a PR to the develop branch. The branch name is like the followings: feature/hminus_opacity, bugfix/hminus, etc.

  • release: we make the release branch prior to a new version release. The contributors are expected to review the release branch.

Issues and Discussion

You can ask anything about ExoJAX in Issue tracker and Discussion.

Tests

As proposed by @gully #86, we now have unit tests using pytest.

  • tests/unittests: Unit tests, fast and independent from other databases as possible
  • tests/integration: mildly fast, it can include external databases
  • tests/endtoend: kind of samples including examples with PPLs

TIPS

How to include data into exojax

  • Edit MANIFEST.in
  • Put data files in data/somewhere/
  • Use pkgutil to load them.

For instance,

import pandas as pd
import pkgutil
from io import BytesIO

adata = pkgutil.get_data('exojax',"data/somewhere/hoge.txt")
dat = pd.read_csv(BytesIO(adata), sep="\s+")