Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

63 lines (37 loc) · 2.69 KB

Contributing

Meerschaum is free and open source software, built to make the lives of data scientists easier. It's my goal to direct the project towards the needs of my users, so the best way you can help steer the development of Meerschaum is to make your voice heard! If you have a need, chances are that someone else down the road will benefit from your present input.

Here are a couple ways you can help out! 💪

  1. Report bugs on the issues tracker.

No matter how large or small, your input is greatly appreciated and gives me a better understanding of the needs of real users.

  1. Join the discussions board.

Feature requests, suggestions, and even showcases are welcome!

  1. Write and publish plugins.

If you publish a plugin to the public api:mrsm repository and post in the plugins showcase discussion, I will review and possibly include it on the List of Plugins reference page.

What About Pull Requests?

PRs are welcome! Due to the development pattern of Meerschaum, I likely may tweak PRs for a number of reasons. A good first step to making changes is to open an issue or start a discussion.

Setting Up A Development Environment

For local development, you will need the following:

  • Docker
  • Git
  • Python

First, clone the Meerschaum repo:

git clone https://github.com/bmeares/Meerschaum.git ~/Meerschaum
cd ~/Meerschaum

Build a local Docker image to install dependencies (note: this will overwrite bmeares/meerschaum on your machine):

./scripts/docker/buildx.sh

Start the development container, which will mount your cloned repository as the installed package in the container.

docker compose up -d

Start a new Bash shell in the container:

docker exec -it mrsm bash

You can now run mrsm commands in the Docker container. Changes you make to your cloned repository will be reflected in the container, so iterate to your heart's content!

The script ./scripts/setup.sh will install dependencies for local development, and ./scripts/build.sh will build a wheel and local documentation. This is only needed for local Python development.

Sponsorship

Consider sponsoring Meerschaum as a way to prioritize your issues or feature requests. Your support is always greatly appreciated! I am available to implement specific features or to design and deploy your architecture using Meerschaum.