Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 1.58 KB

CONTRIBUTING.MD

File metadata and controls

40 lines (23 loc) · 1.58 KB
Raw

Welcome to SwellPy and contributing

We are so excited that you’d like to contribute to SwellPy and its development. With you and the community’s contribution we can further better Swell’s Development ecosystem.

Getting Started

Please follow the README on how to get started with SwellPy

Issues

Create a new issue

Prior to creating an issue, check to see if the Issue already exists. If not, please fill out the Issue form

Solve an issue

If you find an issue that you’d like to tackle, claim it and submit the Pull Request after the contribution has been made. Please follow the following steps to solve an issue

  • Create a branch with the following format: `<user_name><issue_num>
  • Make your changes in this branch
  • When your changes have been made, write corresponding unit test and ensure at least 75% coverage
  • When you are satisfied with the code changes, submit a Pull Request. The Swell Team will review changes and will either approve the Merge Request or have helpful feedback.

Unit Tests

Test Coverage You can easily run Test Coverage report with the following command:

pytest --cov-report term-missing --cov=. ./tests/unit

Guidelines

All members of the project community must abide by the Contributor Covenant, version 2.0. Only by respecting each other we can develop a productive, collaborative community. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer.

Swell Team

Greg Hoskin

Mustafa Hoda

…