Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

27 lines (22 loc) · 1.15 KB

AMY is an open source project, and we welcome contributions of all kinds. By contributing, you are agreeing that Software Carpentry may redistribute your work under this license. You also agree to abide by our contributor code of conduct.

If you would like to know what we need help with, please see the issues on GitHub.

Coding Guidelines

  • Please base your work from develop branch, not main! develop contains latest work that will later become a new release, while main contains latest stable release.
  • All new code must be PEP8 compatible, but legacy code should not be modified unless its meaning is being changed.
  • Contributors are strongly encouraged to write docstrings that conform to PEP257.
  • New functionality should be accompanied by unit tests where feasible.
  • All dates should be formatted as YYYY-MM-DD.

The AMY logo was made using the Bradley Hand font from LibreOffice.