Skip to content

Latest commit

 

History

History
87 lines (53 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

87 lines (53 loc) · 2.6 KB
Raw

Contributing to MudBlazor Icons

Thank you for your interest in contributing to MudBlazor Icons! We welcome contributions from the community and appreciate your efforts to improve this project.

How to Contribute

1. Reporting Issues

If you encounter a bug or have a feature request, please create an issue on GitHub. When reporting an issue, please include:

  • A clear and descriptive title.
  • A detailed description of the problem or suggestion.
  • Steps to reproduce the issue (if applicable).
  • Any relevant logs or screenshots.

2. Fork the Repository

Before you start working on a feature or a bugfix, fork the repository to your GitHub account:

  1. Navigate to the MudBlazor Icons repository.
  2. Click the "Fork" button in the upper right corner.

3. Clone the Repository

Clone the forked repository to your local machine:

git clone https://github.com/MudBlazor/MudBlazor.Icons.git
cd MudBlazor.Icons

4. Create a Branch

Create a new branch for your work. Use a descriptive name for your branch:

git checkout -b feature/your-feature-name

5. Make Your Changes

Make your changes to the codebase. Ensure that your changes are well-documented and include appropriate tests where applicable.

6. Commit Your Changes

Commit your changes with a clear and concise commit message:

git add .
git commit -m "Add new feature: your feature description"

7. Push to GitHub

Push your changes to your forked repository:

git push origin feature/your-feature-name

8. Create a Pull Request

Navigate to the original repository and create a pull request:

  1. Go to the pull requests section of the original repository.
  2. Click "New pull request".
  3. Select your branch from the "compare" dropdown.
  4. Provide a clear title and description for your pull request.
  5. Click "Create pull request".

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

Style Guide

Please follow the project's coding style and conventions. Consistent code style helps maintain readability and ease of maintenance.

License

By contributing to MudBlazor Font Icons, you agree that your contributions will be licensed under the MIT License.

Getting Help

If you need help or have any questions, feel free to open an issue on GitHub or reach out to the maintainers.

Thank you for your contributions!