Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

52 lines (32 loc) · 1.87 KB
Raw

Contributing to Open Notebook

First off, thank you for considering contributing to Open Notebook! What makes open source great is the fact that we can work together and accomplish things we would never do on our own. All suggestions are welcome.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct (to be created separately).

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with a clear title and detailed description of the suggested enhancement.
  • Provide any relevant examples or mockups if applicable.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Python Styleguide

  • Follow PEP 8 guidelines
  • Use type hints where possible
  • Write docstrings for all functions, classes, and modules

Documentation Styleguide

  • Use Markdown for documentation files
  • Reference functions and classes appropriately

Additional Notes

Thank you for contributing to Open Notebook!