Contributing

Contributions can come in many forms, we always need help improving the documentation. If you find issues with the documentation, usability, code, or even a question, please open an issue to let us know and or post in the Gitter Chat.

• What To Work On
  • Who’s Working On What
  • Contacting the Community
  • Communication Style
• Getting Set Up To Work On DFFML
  • Installing Plugins In Development Mode
  • Virtual Environment
  • Containerized Development Environment
• Style
  • Python File Formatting
  • JavaScript File Formatting
  • Naming Conventions
  • Imports
  • Docstrings
• Codebase Layout And Notes
  • Plugins
  • Double Context Entry Pattern
  • Config
  • setup.py
  • Notes on Various Subsystems
• Git and GitHub
  • Issue and Pull Request title formatting
  • Submitting A Pull Request
  • Rebasing in branches
  • How to Read the CI
• Testing
  • Writing Tests
  • Running CI Tests Locally
  • Debug Logging
  • Test Coverage
  • Test Datasets
• Documentation
  • Examples
  • Setup for Example Code
  • Doctests
• Notebooks
  • Code Formatting
  • Testing
  • Documentation
• consoletest Sphinx extension
  • Example
  • Options
• Debugging
  • Pop open debugger on execption
  • Plugin Loading / Entrypoint Issues
• Setting Up Your Editor
  • Visual Studio Code (VSCode)
• Google Summer of Code
  • Proposal Grading Rubric
  • GSoC 2021
  • GSoC 2020
  • GSoC 2019
• Maintainer Docs
  • Adding A New Plugin
  • Doing a Release