Contributing#

 

This section outlines the guidelines for contributing to this repository, in terms of classification mapping, issues reporting, and changes.

Classification Mapping#

If you have new product classification system that you would like to map to the BONSAI classification so that to facilitate the integration of data both upstream and downstream, please leave an issue. You can have a dataset of all the available correspondence via BONSAI’s correspondence API endpoints.

Reporting Issues#

If you encounter a problem or have a suggestion, please follow these steps:

  1. Search the Issue Tracker: Your issue might already be reported. Please review existing issues before submitting a new one.

  2. Create a New Issue: If you’re unable to find an issue that matches your concern, open a new one. Provide a detailed description using the automatically generated template.

Contributing Changes#

Merge Request Process#

  1. Fork the repository and create your branch from the main branch.

  2. Testing: test the functionalities you created with the testing routine written below.

  3. Update the docs/ with details of changes to the interface with documentation specifics written below.

  4. Submit a merge request using the auto-generated template.

Testing#

  • Testing task

    To test the fitness of a new task, you can add it into the task_registration.py and run it in the workflow by:

    from bonsai.io import Workflow

workflow = Workflow()

# Test single task run
workflow.run_task("my_task")

# Test task compatability with other tasks
workflow.execute(start="my_task")
workflow.execute(start="some_existing_task", stop="my_task")

Documentation#

  • For general formats, please use a combination of isort and Black.

  • Docstring is written in numpy style. autoDocString is recommended.

  • sphinx and autoapi is used for automatic documentation. Please test your documentation with tox -e docs.

Thank you for your interest in contributing to BONSAI-IO! 🌟 We value the contributions of each member of the community and look forward to your ideas, feedback, and contributions.