Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (63 loc) · 4.23 KB

CONTRIBUTING.md

File metadata and controls

81 lines (63 loc) · 4.23 KB

Contributing to Fiats

Reporting Defects or Suggesting Features

If you encounter problems or limitations when installing or using Fiats, please do the following:

  1. Search the Fiats issues, including closed issues. If your search finds a report of the same problem, please post a comment in the issue.
  2. Email the Fiats mailing list for advice.
  3. If steps 1 or 2 do not resolve the problem, please file a new issue including
    • The Fortran compiler and compiler version used with Fiats,
    • The complete output of the build command run with --verbose argument,
    • The Fiats version number or commit hash,
    • Any conditions required to reproduce the problem such as
      • The output of uname -a showing the operating system (OS), OS version, and processor architecture,
      • The command used to run your program (e.g., fpm run ...), and
      • Details about the model input file used

Contributing Code or Documentation

We welcome help with diagnosing, isolating and fixing problems or adding features! All contributions are governed by the Fiats LICENSE.txt. To contribute, please follow these steps:

  • First please follow the above steps and include a description of your proposed contribution.
  • Fork the Fiats repository into your GitHub account
  • Create a new local branch for your work.
  • Name your branch according to the issue created. For example fix-issue-53 or issue-53-feature.
  • Make your commits logically atomic, self-consistent, and cohesive.
  • Add one or more unit tests in the test subdirectory to verify your fix or feature.
  • Ensure that your branch passes all tests (via fpm test with appropriate flags).
  • Update the README.md if your branch affects anything described there.
  • Push your branch to your fork.
  • Open a Pull Request (PR) against an existing branch of the Berkeley Lab Fiats repository.
  • Please include the corresponding issue number in the PR title.
  • If your PR is not ready for merging, please click the downward arrow next to the "Create pull request" button and select the "Create draft pull request" option before submitting.
  • Watch for CI results on your PR and address any failures.
  • Please be patient and responsive to comments on your PR.

Current and Past Contributors

Fiats is an open-source project and welcomes community participation in the development process. Notable current and past contributors include:

You can also browse the full list of repository contributors.