Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 2.03 KB

Contributing to succulent

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

Code of Conduct

This project and everyone participating in it is governed by the succulent Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check existing issues list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible in the issue template.

Suggesting Enhancements

Open new issue using the feature request template.

Pull requests

Fill in the pull request template and make sure your code is documented.

Setup development environment

Requirements

After installing Poetry and cloning the project from GitHub, you should run the following command from the root of the cloned project:

poetry install

All of the project's dependencies should be installed and the project ready for further development. Note that Poetry creates a separate virtual environment for your project.

Dependencies

Package Version Platform
pandas ^2.0.1 All
pyyaml ^6.0 All
flask ^2.3.2 All
xmltodict ^0.13.0 All
lxml ^5.1.0 All

Development dependencies

Package Version Platform
pytest ^6.2 Any
sphinx ^4.4.0 Any
sphinx-rtd-theme ^1.0.0 Any
sphinxcontrib-bibtex ^2.4.1 Any

Development Tasks

Testing

Manually run the tests:

poetry run pytest