Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 2.6 KB
Raw

Contributing to MiniSpace

Thank you for your interest in contributing to MiniSpace! We appreciate contributions that enhance the application's capabilities using .NET, Blazor, Radzen, and MudBlazor. Whether you are fixing a bug, adding a feature, or improving the documentation, your input is invaluable.

We Develop with Github

We use GitHub to host code, track issues and feature requests, and accept pull requests.

Contribution Process

We follow the GitHub Flow, so all code changes happen through pull requests. Here’s how you can contribute:

  1. Fork the repo and create your branch from main.
  2. If you've added code, please add tests. This is crucial for ensuring the integrity of the application.
  3. Ensure the test suite passes and your code adheres to the coding standards detailed below.
  4. Submit your pull request!

Specific Technologies

Since our project is built with .NET and specifically utilizes Blazor, Radzen, and MudBlazor for the front-end:

  • Blazor: Ensure your contributions are compatible with the latest stable version of Blazor.
  • Radzen: Contributions using Radzen components should follow the best practices recommended by Radzen documentation.
  • MudBlazor: Use MudBlazor for designing responsive elements and UI components. Adhere to MudBlazor's guidelines for consistency across the application.

Coding Style

  • .NET and C#: Follow the C# Coding Conventions.
  • Blazor: Code should be clean, well-commented, and organized within the appropriate structure.
  • Radzen and MudBlazor: Ensure components and services are properly configured and utilized according to the framework's standards.

Bug Reporting and Pull Requests

  • Report bugs through GitHub issues.
  • Write detailed bug reports with a clear background and steps to reproduce.
  • Pull requests should be clear and concise, mentioning the intent of changes and any related issues.

Licensing

Any contributions you make will be under the same Apache License that covers the project, ensuring that MiniSpace remains open and free for the community.

Appreciation

Your contributions are what make the open-source community an amazing place to learn, inspire, and create. Every contribution counts and is greatly appreciated.

This document was adapted from open-source guidelines to align with MiniSpace’s specific focus on .NET technologies, especially Blazor, Radzen, and MudBlazor.