Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (51 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

61 lines (51 loc) · 2.42 KB

Contributing to Dokploy MCP

⚠️ THIS PROJECT HAS BEEN DISCONTINUED

This repository no longer accepts contributions as it has been moved to the official Dokploy organization.

📍 To contribute, visit the new repository: https://github.com/Dokploy/mcp

First off, thank you for considering contributing to Dokploy MCP! Your help is greatly appreciated.

How Can I Contribute?

There are many ways you can contribute to the project:

  • Reporting Bugs: If you find a bug, please open an issue and describe it in detail, including steps to reproduce it.
  • Suggesting Enhancements: If you have ideas for new features or improvements to existing ones, feel free to open an issue to discuss them.
  • Writing Code: You can help by fixing bugs or implementing new features.
  • Improving Documentation: If you find any part of the documentation unclear or incomplete, please let us know or submit a pull request with your improvements.
  • Providing Feedback: General feedback on the project is always welcome.

Getting Started

  1. Fork the Repository: Click the "Fork" button at the top right of the Dokploy MCP GitHub page.
  2. Clone Your Fork: 
    git clone https://github.com/andradehenrique/dokploy-mcp.git
cd dokploy-mcp
  3. Set Upstream Remote: 
    git remote add upstream https://github.com/andradehenrique/dokploy-mcp.git
  4. Create a New Branch: 
    git checkout -b feature/your-feature-name  # For new features
# or
git checkout -b bugfix/issue-number-or-description # For bug fixes
  5. Make Your Changes: Write your code, add tests, and ensure all existing tests pass.
  6. Commit Your Changes: Follow good commit message practices. 
    git commit -m "feat: Add new amazing feature"
# or
git commit -m "fix: Resolve issue #123 by doing X"
  7. Push to Your Fork: 
    git push origin feature/your-feature-name
  8. Open a Pull Request (PR): Go to the original Dokploy MCP repository and open a pull request from your forked branch. Provide a clear description of your changes.

Coding Guidelines

  • Follow the existing code style.
  • Write clear and concise comments where necessary.
  • Ensure your code is well-tested.
  • Update documentation if your changes affect it.

Thank you for your contribution!