Contributing.md

Contributing

Contributions to DockFlare are welcome! Whether it's reporting a bug, suggesting an enhancement, or submitting code changes, your input is valuable and helps make DockFlare better for everyone.

Reporting Issues

• Found a bug or unexpected behavior? Please check the existing issues first to see if it has already been reported.
• If not, please open a new issue.
• Include the following details in your report:
  • DockFlare version (e.g., image tag like stable or latest, or commit hash if running from source).
  • Your environment (Docker version, OS).
  • Relevant configuration details (especially .env settings, sanitized of secrets).
  • Example container labels you are using.
  • Detailed steps to reproduce the issue.
  • What you expected to happen.
  • What actually happened (include relevant logs or error messages).

Suggesting Enhancements

• Have an idea for a new feature or an improvement to an existing one?
• Open a new issue, describing the feature and its potential benefits. Explain the use case it would solve.

Submitting Pull Requests

1. Fork the Repository: Create your own copy of the ChrispyBacon-dev/dockflare repository on GitHub.
2. Create a Branch: Create a new branch in your forked repository for your changes. Use a descriptive name (e.g., feature/add-new-label or fix/resolve-api-error).

   git checkout -b feature/my-amazing-feature

3. Make Your Changes: Implement your feature or bug fix. Ensure your code follows the project's style and conventions. Add tests if applicable.
4. Commit Your Changes: Commit your work with clear and concise commit messages.

   git add .
   git commit -m "feat: Add support for XYZ feature"
   # or
   git commit -m "fix: Correct handling of edge case ABC"

5. Push to Your Branch: Push your changes to your forked repository on GitHub.

   git push origin feature/my-amazing-feature

6. Open a Pull Request: Go to the original ChrispyBacon-dev/dockflare repository and open a Pull Request (PR) from your feature branch to the appropriate base branch (e.g., stable or main/master).
   • Provide a clear title and description for your PR, explaining the changes and referencing any related issues (e.g., "Closes #123").
   • Be prepared to discuss your changes and potentially make adjustments based on feedback.

---

Support the Project

If you find DockFlare helpful and want to support its ongoing development, maintenance, and the time dedicated to it, consider showing your appreciation!

You can support me directly via GitHub Sponsors:

Your support helps keep the project alive and motivates further improvements.

Thank you for contributing to DockFlare!

---