Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

66 lines (49 loc) · 2.89 KB

Contributing to Virtual Scanner

👍 🎉 First off, thanks for taking time to contribute! 👍 🎉

The following is a set of guidelines for contributing to Virtual Scanner. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of contents

  1. Contributing
  2. Reporting Issues
  3. Seeking Support

These can be very brief. Also, for folks not familiar with the CONTRIBUTING.md file, maybe make a quick mention of it in your README.md and link to it.

Contributing to the Software

If you would like to contribute to Virtual Scanner, please Fork and make a pull request with adequate documentation of functionality. In addition, please take a look at the Code of Conduct and documentation guide below:

Code of Conduct

This project and everyone participating in it is governed by the Virtual-Scanner Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to imr.framework2018@github.com.

PEP Style Guide for Python Code

Read through the Style Guide for Python Code and follow the coding conventions. If you notice any of Virtual-Scanner's code not adhering to PEP8, submit a pull request or open an issue.

Source code header

Insert and fill out the following header comments at the top of every script in your source code:

Institution : (your university/research facility)
Version : 1.0.0

Note that "Version" refers to the Virtual Scanner release you developed your code on. You can add more fields if needed.

Documenting source code

Please add a top-level description of code functionality in each script. In addition, document every class and method in your source code using the Numpy docstring guide. An example is shown below.

def addition(a, b):
  """
  Addition of two numbers.
  
  Parameters
  ----------
  a : int, float
    Operand 1
  b : int, float
    Operand 2
    
  Returns
  -------
  Arthimetic sum of operand 1 and operand 2.
  """
  return a + b

Reporting Issues

Please report issues in Github Issues, following the given format for either "Bug Report" or "Feature Request". If there are issues with a specific GUI page, please use one of these links:

Seeking Support

For support in installing and using Virtual Scanner, please feel free to either use Github Issues or ask on our Slack channel.