Contributing

plotjs is still in a very early stage, but contributions is still welcomed!

The best way to help the development is to:

• list the bugs you found by opening GitHub issues
• list the features you'd like to see by opening GitHub issues

Setting up your environment

You need to have the following installed on your machine:

• uv
• Git
• npm

Install for development

• Fork the repository to your own GitHub account.

• Clone your forked repository to your local machine:

git clone https://github.com/github_user_name/plotjs.git
cd plotjs
git remote add upstream https://github.com/y-sunflower/plotjs.git

• Create a new branch:

git checkout -b my-feature

• Set up your Python environment:

uv sync --all-groups --dev
uv run pre-commit install
uv pip install -e .

• Install npm dependencies:

npm install

Code

You can now make changes to the package and start coding!

Run the test

• Test that everything works correctly by running:

make test

Preview documentation locally

make preview

Push changes

• Commit and push your changes:

git add -A
git commit -m "description of what you did"
git push

• Navigate to your fork on GitHub and click the "Compare & pull request" button to open a new pull request.

Congrats! Once your PR is merged, it will be part of plotjs.