Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (28 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

33 lines (28 loc) · 1.62 KB
Raw

Devito.jl contributor guidelines

Issue reporting

If you have found a bug in Devito.jl or have any suggestions for changes to Devito.jl functionality, please consider filing an issue using the GitHub isssue tracker. Please do not forget to search for an existing issue which may already cover your suggestion.

Contributing

We try to follow GitHub flow (https://guides.github.com/introduction/flow/) for making changes to Devito.jl.

Contributors retain copyright on their contributions, and the MIT license (https://opensource.org/licenses/MIT) applies to the contribution.

The basic steps to making a contribution are as follows, and assume some knowledge of git:

  1. fork the Devito.jl repository
  2. create an appropriately titled branch for your contribution
  3. if applicable, add a unit-test to ensure the functionality of your contribution (see DevitoOpen/test, and DevitoPro/test for devitopro-only tests).
  4. run the tests from a Julia project that has this repository's Devito and one backend dev'd into it. For example, from the repository root: ]activate --temp, ]dev ./Devito ./DevitoOpen, ]test DevitoOpen (or ./DevitoPro and ]test DevitoPro). See the CondaPkg notes in the README to avoid rebuilding the conda environment on every run.
  5. make a pull-request
  6. have fun

Coding conventions

We try to follow the same coding conventions as https://github.com/JuliaLang/julia. This primarily means using 4 spaces to indent (no tabs). In addition, we make a best attempt to follow the guidelines in the style guide chapter of the julia manual: https://docs.julialang.org/en/v1/manual/style-guide/