Sibyl
  • Welcome to Sibyl
  • Getting Started
    • 💻Installation
    • 🚀Quickstart
  • User Guides
    • 🗃️Preparing the Database
      • Required Inputs
      • Configuring Applications
      • Populating the Database
        • sibyl.db API docs
    • 📡Running the REST-API Server
  • Developer Guides
    • ☺️Contributing to Sibyl
      • Types of Contributions
      • Making Contributions
      • Pull Request Guidelines
      • Code Style Guide
      • Unit Testing Guidelines
      • Release Workflow
  • Important Links
    • 📚API Documentation
    • 🔧Issues
    • ⚖️License
Powered by GitBook
On this page
  • Report Bugs
  • Fix Bugs
  • Implement Features
  • Write Documentation
  • Submit Feedback
  1. Developer Guides
  2. Contributing to Sibyl

Types of Contributions

Report Bugs

Report bugs at the Github Issues page

If you are reporting a bug, please include:

  • Your operating system name and version.

  • Any details about your local setup that might be helpful in troubleshooting.

  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

Sibyl could always use more documentation, whether as part of the official Sibyl docs (that you are currently reading), in docstrings, or on the web in blog posts, articles, etc.

Submit Feedback

The best way to send feedback is to file an issue at the Github issues page.

If you are proposing a feature:

  • Explain in detail how it would work.

  • Keep the scope as narrow as possible, to make it easier to implement.

  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

PreviousContributing to SibylNextMaking Contributions

Last updated 1 year ago

☺️