Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

25 lines (17 loc) · 1.02 KB

Contributing

All contributions are welcome, just open a PR and let's talk! As this project matures, I'll come up with interface and style guidelines.

Table of Contents

Pull Request Checklist

  • Add tests for new features
  • Add documentation for new features
  • Add a line to the CHANGELOG.md file describing the new feature
  • All tests pass
  • The code is formatted with JuliaFormatter (see Style Guide below)

Style Guide

This repository follows SciML's Style. The exact flavor is described in the file ./JuliaFormatter.toml.

Before opening a PR, please run using JuliaFormatter; format(".") in the root directory of the repository to make sure that your contributions are formatted accordingly.

If your contribution is not formatted, the CI will fail and you will be asked to format your code before the PR can be merged.