Contributing to DockFlare

First off, thank you for considering contributing to DockFlare! Community contributions are incredibly valuable. This document provides some guidelines for contributing.

How You Can Help

  • Reporting Bugs: Open an Issue on GitHub with detailed steps to reproduce the bug.
  • Suggesting Enhancements & Ideas: Start a Discussion on the GitHub repository's "Discussions" tab.
  • Improving Documentation: Your feedback or pull requests to improve the documentation are welcome.
  • Submitting Pull Requests: If you'd like to contribute code, please follow the guidelines below.

Guidelines for Pull Requests

  1. Discuss First: For significant changes, please open an Issue or start a Discussion first to align on the approach.
  2. Branching: Create a new branch for your feature or bug fix (feature/your-feature or fix/your-bug).
  3. Code Style: Follow PEP 8 for Python. Use clear variable and function names.
  4. Testing: Test your changes thoroughly and describe the testing process in your pull request.
  5. Documentation: Update the README.md or this documentation if your changes affect user-facing functionality.
  6. Submit the PR: Open a Pull Request against the unstable branch of the main DockFlare repository. Provide a clear description of your changes.

Community & Support

  • For bug reports, please use the GitHub Issues tracker.
  • For feature requests, questions, ideas, or general discussion, please use the GitHub Discussions board.

This is a summary of the full CONTRIBUTING.md. For more details, please see the original file in the repository.