Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (41 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 2.16 KB

Contributing to Box MCP Server

First off, thank you for considering contributing to Box MCP Server! It's people like you who make it such a great tool for everyone.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to @hmk.

How can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots if possible

Suggesting Enhancements

If you have a suggestion for the project, we'd love to hear about it! Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • A clear and descriptive title
  • A detailed description of the proposed enhancement
  • Explain why this enhancement would be useful
  • List any potential drawbacks
  • If possible, suggest a potential implementation approach

Pull Requests

  1. Follow the style guides
  2. After you submit your pull request, verify that all status checks are passing

Style Guides

Git Commit Messages:

  • Use Conventional Commits
  • Use the present tense ("Add Feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Development Process

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. If you've changed APIs, update the documentation
  4. Ensure the test suite passes
  5. Make sure your code lints
  6. Issue that pull request!

Questions?

Don't hesitate to ask questions about the contribution process. You can:

Open an issue with your question

Thank you for contributing! 🎉