Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 1.62 KB
Raw

CONTRIBUTING

We are happy to have you reading this file as we welcome contributions from community. Here you will find the information on how to start contributing to SCALAR.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Contribuiton to a GitHub Project

If you are not familiar with GitHub and how to contribute to a github project, check the following links as a good first step:

If you have an idea what can be improved or added to the system, or you found a bug, report an issue. We will respond promptly to your proposal.

Code style and documentation

  • Python code shall comply with PEP 8
  • Documentation shall be in docstring.
  • The names for new modules and methods should be intuitive.
  • If possible, provide a way to test the new module.

Submitting updates

Send your GitHub pull request to SCALAR with a clear statement of what you have done. Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. Test the functionality of the module before sending the PR. Please follow our code conventions and write clear messages for your commits.