Skip to main content

🚀 Welcome to Velero UI, Contributors! 🚀

Thank you for your interest in contributing to Velero UI! This guide will help you navigate the process to ensure your contributions make a meaningful impact.

💡 How to Contribute​

Ready to contribute? Awesome! Here’s how you can get involved:

🌟 Code Contribution Guidelines​

We encourage you to submit pull requests! Before doing so, please:

  1. Start a discussion about your ideas here.
  2. Follow the coding standards and ensure new features are well-tested.
  3. Update any relevant documentation.
  4. Write clear, concise commit messages.

🛠 Best Practices for Code PRs:​

  1. Maintain Code Consistency: Ensure your contributions align with the project's existing standards.
  2. Minimize External Dependencies: Avoid introducing new external dependencies without prior discussion.
  3. Framework Independence: We strive to remain framework-agnostic. Build core functionalities without relying heavily on external libraries. If you're uncertain, feel free to open a discussion.

Thank you for contributing! 🚀

📚 Improve Documentation & Tutorials​

Help make Velero UI more accessible by enhancing our documentation, writing tutorials, or creating guides for setting up and optimizing the UI.

🤔 Questions & Feedback​

Got questions or suggestions? Join our Discord community or open an issue. We’re here to assist you!

📌 Important Points​

🧭 Velero UI Scope​

Velero UI focuses on delivering an intuitive, responsive interface for web-based applications. If you encounter an issue related to the environment (e.g., Docker setups), we encourage familiarity with Docker fundamentals. Check the official Docker documentation for more information.

  • Docker Support: Velero UI supports Docker, but you’ll need a solid understanding of Docker basics.
  • Advanced Configurations: For reverse proxies or other complex setups, we recommend learning Docker and related tools to ensure a smooth experience.

🚨 Reporting Issues​

Found a bug or have a suggestion? Check the Issues tab to see if it’s been reported. If not, feel free to open a new issue. When reporting, please use the templates provided for detailed and efficient tracking.

  • Template Compliance: Issues that don’t follow the templates or lack essential information may be closed to maintain our issue tracker’s integrity.
  • Detailed Descriptions: Include clear descriptions, reproduction steps, and expected versus actual results for us to address your issue efficiently.

🙏 Thank You!​

Every contribution, big or small, helps make Velero UI a better tool. We can’t wait to see what you’ll bring to the project!