Development

While skrub is still in its early stages, we believe in openness and community development from the start. Join us in building a great package to facilitate learning on databases.

• Vision: Where is skrub heading?
  • Vision Statement
  • Roadmap
• About
• Contributing guide
  • Have a question?
  • What to know before you begin
  • How can I contribute?
    • Reporting bugs
      • How to submit a bug report?
      • How to write an example?
    • Suggesting enhancements
      • How to submit an enhancement proposal?
        • If the enhancement proposal is validated
        • If the enhancement is refused
    • Writing your first Pull Request
      • Preparing the ground
      • Setting up the environment
      • Implementation Guidelines
  • Checking the quality of your code contribution
    • Testing the code
    • Checking coverage on the local machine
    • Updating doctests
    • Formatting and pre-commit checks
    • Ensuring the documentation builds
    • Editing the API reference documentation
  • Submitting your code
    • Updating the changelog
    • Continuous Integration (CI)
      • Integration
• How to write an example for the gallery
  • Location of the examples
    • Dealing with typos in the example
  • Writing the example
  • Running the example
  • Adding cross-references
  • Generating the new documentation
  • Linking your work to examples already in the documentation
  • Merging your example
• Release process
  • Target audience
  • Process
    • Preparing the release branch
    • Meanwhile, preparing the post-released PR
    • The doc update has succeeded
    • Pushing the wheel to Pypi
    • Update the conda-forge recipe