Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (36 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

49 lines (36 loc) · 2.18 KB

Contribution Guidelines for MylibSQLAdmin

Thank you for considering contributing to MylibSQLAdmin—a modern, open-source GUI for managing libSQL (SQLite-compatible) databases. Your contributions help improve the project for everyone.

Before You Start

  • Check Existing Issues: Review open issues to avoid duplicating efforts.
  • Understand the Project: Familiarize yourself with the project's structure and goals by reading the README or DeepWiki.

How to Contribute

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page.
  2. Clone Your Fork: 
    git clone https://github.com/darkterminal/mylibsqladmin.git
  3. Create a New Branch: 
    git checkout -b feature/your-feature-name
  4. Make Your Changes: Implement your feature or fix.
  5. Test Your Changes: Ensure your changes don't break existing functionality.
  6. Commit and Push: 
    git add .
git commit -m "Describe your changes"
git push origin feature/your-feature-name
  7. Submit a Pull Request: Go to your fork on GitHub and click "Compare & pull request."

Development Environment

  • Docker: The project uses Docker for development. Refer to the compose.yml files for setup.
  • Makefile: Utilize the provided Makefile for common tasks.
  • Environment Variables: Use .env.example as a template for your environment configuration.

Code Standards

  • Language: Ensure your code is clean and well-documented.
  • Style: Follow consistent coding styles and conventions used in the project.
  • Commits: Write clear and descriptive commit messages.

🧾 Licensing

By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.

📬 Need Help?

If you have questions or need assistance, feel free to open an issue or join our community discussions.