Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.07 KB

Contributing

Contributions are welcome from the community. Questions can be asked on the issues page. Before creating a new issue, please take a moment to search and make sure a similar issue does not already exist. If one does exist, you can comment (most simply even with just a 👍) to show your support for that issue.

If you have direct contributions you would like considered for incorporation into the project you can fork this repository and submit a pull request for review.

Contributed models should be written in Python (compatibility with python 3.x is preferred).

You need to upload the Python source code files to the git repository

TODO

  • provide a template (see https://www.ncnr.nist.gov/staff/dimeo/panweb/pan_functions.html as an example)
  • give instructions (all requirements: code, documentation, test, test data, naming conventions, organization of library (peak, background, instrument resolution...)
  • provide tool to validate: naming, code, convergence of fit,

to be completed ...