Contribution

We welcome and appreciate contributions from the community! If you're keen on enhancing LightningUserVault, this guide will help you understand our standards and processes

🚀 Getting Started:

Before diving into contributions, it's beneficial to familiarize yourself with our past work. A great way to do this is by exploring our closed PRs.

🌟 Contribution Guidelines:

1. Branch Naming:

   • Format: owner/what_pr_does

   • Example: john/fix-login-bug

2. PR Review Process:

   • Before submitting your PR for review, ensure all GitHub actions are successful.

3. GitHub Actions:

   • 📜 Go Linter: Ensures the code adheres to quality and standards.

   • ✅ Verify PR: Assesses the completeness of the PR description.

   • 🧪 Unit Tests: Confirms that individual code units function as intended.

   • 🌀 Fuzz Tests: Validates code robustness by processing random inputs.

   • 🌐 E2E Tests: Tests the end-to-end functionality of specific application areas.

🙏 Conclusion:

By adhering to these guidelines, we can maintain the high quality and functionality of LightningUserVault. Your contributions play a significant role in achieving this benchmark!