Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (37 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 2.69 KB

🤝 Contributing to Apex Log MCP Server

🎉🥳 Thank you for contributing! 🥳🎉

We truly appreciate your help in making Apex Log MCP Server better. Whether you're fixing a bug, adding a feature, or improving documentation, your contributions are invaluable to us!

Before you dive in, please make sure to review our code of conduct to ensure a welcoming environment for everyone.

📋 Before You Start

Search for Existing Issues

  1. Check out the open issues first to see if your idea or bug has already been reported.
  2. If you don’t see anything related, open an issue! We’d love to hear your thoughts and provide feedback or suggestions before you get started. This helps avoid duplicate work and ensures we’re aligned.

🛠️ Setting Up Your Development Environment

For detailed instructions on setting up your development environment, refer to the Development Guide.

🚀 Ready to Contribute?

We can't wait to see your contributions! Whether it’s fixing a bug, adding a new feature, or improving the docs, we truly appreciate your time and effort.

Quick Recap of Steps

  1. Fork the repo.
  2. Clone your fork locally.
  3. Create a feature branch e.g (feat-some-description or bug-some-description).
  4. Make your changes.
  5. Push your changes.
  6. Open a PR for review!

📅 Commit Message Guidelines

  • We follow a simple format for commit messages: Conventional Commits
  • Use the imperative mood in the subject line (e.g., "fix: date parsing in log parser" rather than "fixed date parsing in log parser").

Commit Examples

  • feat: add namespace filtering to performance analysis
  • fix: handle empty debug logs gracefully
  • docs: add Claude Desktop configuration example
  • refactor: simplify trace flag validation
  • test: add coverage for bottleneck detection

✅ Before Submitting

Please verify the following before opening a PR:

  • All tests pass (pnpm test)
  • TypeScript compiles without errors (pnpm run build)
  • Linting passes (pnpm run lint)
  • New features include tests where appropriate

💬 Need Help?

If you get stuck at any point, feel free to open an issue or reach out to us in the discussions tab. We’re here to help and we want to make your contribution experience as smooth as possible. 🤗

Thank you again for contributing to Apex Log MCP Server! Your input helps make this tool even better for Salesforce developers. 🙌