Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

43 lines (25 loc) · 1.55 KB
Raw

Contributor Guidelines

Thank you for your interest in contributing to the Open Reflectometry Project.

When contributing to the project, please first discuss the addition or change you wish to make via the issues page, email, or any other method with the other members of the project.

Please note that we have a code of conduct that you should follow in all your interactions with the project.

Submitting a Pull Request

You may submit a Pull Request (PR) to add a new tutorial, example, raw data or add or change the functionality of the Python library. To do this, follow the steps below.

  1. Ensure that you are running the latest version of scikit-reflectometry.
  2. Ensure that you have added your name to the contributors list in the README file
  3. Provide a description of your changes in the PR message.
  4. Add the number of the issue related to the discussion of this change to your PR message.

Types of Contributions

Your contributions to the Open Reflectometry Project may be any of the following

  • Code changes and improvements

  • Adding features to the library:

    • turbulence measurement processing
    • density profile reconstructions
    • correlation analysis

  • Examples on how to use the library functions and tools

  • Contributing to the documentation

  • Raw data of reflectometry measurements

  • Tutorials of loading raw data, processing and visualization of processed data