Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (52 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

70 lines (52 loc) · 2.06 KB
Raw

Contributing to WasmMvcRuntime

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

🚀 Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR-USERNAME/WasmMvcRuntime.git
  3. Create a new branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test your changes
  6. Commit your changes: git commit -m "Add your descriptive commit message"
  7. Push to your fork: git push origin feature/your-feature-name
  8. Create a Pull Request

📝 Code Guidelines

  • Follow the existing code style and conventions
  • Use meaningful variable and method names
  • Add XML documentation comments for public APIs
  • Keep methods focused and concise
  • Write unit tests for new functionality

🧪 Testing

  • Ensure all existing tests pass before submitting a PR
  • Add tests for new features
  • Test your changes in the browser with different routes

📋 Pull Request Process

  1. Update the README.md with details of changes if applicable
  2. Update the documentation with any new features or changes
  3. Ensure your code follows the project's coding standards
  4. The PR will be reviewed by maintainers
  5. Address any feedback or requested changes
  6. Once approved, your PR will be merged

🐛 Reporting Bugs

When reporting bugs, please include:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots if applicable
  • Environment details (OS, .NET version, browser)

💡 Suggesting Enhancements

When suggesting enhancements, please include:

  • A clear and descriptive title
  • Detailed description of the proposed feature
  • Use cases and examples
  • Any potential drawbacks or considerations

📜 Code of Conduct

  • Be respectful and inclusive
  • Welcome newcomers and help them get started
  • Focus on constructive feedback
  • Accept criticism gracefully

📧 Questions?

If you have questions, feel free to:

  • Open an issue on GitHub
  • Reach out to the maintainers

Thank you for contributing! 🎉