Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (32 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 1.3 KB

Contributing to Encrypted SQLite MCP Server

Thank you for your interest in contributing! This document provides guidelines for contributing to the project.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/yourusername/mcp-encrypted-sqlite.git
  3. Create a branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test your changes: ./gradlew test
  6. Commit your changes: git commit -m "Add feature: description"
  7. Push to your fork: git push origin feature/your-feature-name
  8. Open a Pull Request

Code Style

  • Follow Java naming conventions
  • Use meaningful variable and method names
  • Add JavaDoc comments for public methods
  • Keep methods focused and small
  • Write unit tests for new functionality

Testing

  • All new features should include unit tests
  • Run tests before submitting: ./gradlew test
  • Ensure all tests pass

Commit Messages

  • Use clear, descriptive commit messages
  • Start with a verb in imperative mood (e.g., "Add", "Fix", "Update")
  • Reference issues when applicable: "Fix #123: description"

Pull Requests

  • Keep PRs focused on a single feature or fix
  • Update documentation if needed
  • Ensure CI checks pass
  • Request review from maintainers

Questions?

Feel free to open an issue for questions or discussions.