Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

33 lines (27 loc) · 1.25 KB

Contributing to Dedalus

Thank you for your interest in contributing to Dedalus! We welcome contributions in the form of bug reports, feature requests, documentation improvements, and code contributions.

Asking for Help

  • For help installing Dedalus or setting up a simulation, please use the Google Group.
  • For help with source code modifications or additions, please use GitHub issues and pull requests.

Reporting Issues

  • Please search existing issues to avoid duplicates.
  • Provide a clear, minimal working example if reporting a bug.
  • Use descriptive titles and labels when possible.

Code Contributions

  • Please generally follow PEP 8 for style.
  • Write docstrings in the Numpy format.
  • Try to make small commits with meaningful commit messages.
  • Ensure tests pass by running: 
    python3 -m dedalus test
  • Open a pull request with a clear description of changes.
  • Feel free to open early/draft pull requests and ask for help!

Documentation

  • Improve docs by editing .rst files in docs/.
  • Build docs locally with: 
    cd docs
make html

We appreciate your contributions!