From 1b820d673e9378170f0c0e97c146145251a4cb05 Mon Sep 17 00:00:00 2001 From: Artyom M Date: Thu, 4 Jul 2024 14:21:53 +0300 Subject: [PATCH] Create a separate CONTRIBUTING.md (#6) --- CONTRIBUTING.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 13 ++++--- 2 files changed, 104 insertions(+), 4 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ad9d112 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,95 @@ +# Contributing to MudBlazor Translations + +Thank you for your interest in contributing to MudBlazor Translations! We welcome contributions from the community and appreciate your efforts to improve this project. + +## How to Contribute + +### 1. Localization + +If you want to add or modify translations, please visit our [Weblate project](https://hosted.weblate.org/engage/mudblazor/). Weblate is our translation management platform. + +### 2. 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. Code Contributions + +If you intend to contribute to the code itself, please follow the instructions below: + +#### 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 Translations repository](https://github.com/MudBlazor/Translations). +2. Click the "Fork" button in the upper right corner. + +#### Clone the Repository + +Clone the forked repository to your local machine: + +```bash +git clone https://github.com/MudBlazor/Translations.git +cd Translations +``` + +#### Create a Branch + +Create a new branch for your work. Use a descriptive name for your branch: + +```bash +git checkout -b feature/your-feature-name +``` + +#### Make Your Changes + +Make your changes to the codebase. Ensure that your changes are well-documented and include appropriate tests where applicable. + +#### Commit Your Changes + +Commit your changes with a clear and concise commit message: + +```bash +git add . +git commit -m "Add new feature: your feature description" +``` + +#### Push to GitHub + +Push your changes to your forked repository: + +```bash +git push origin feature/your-feature-name +``` + +#### Create a Pull Request + +Navigate to the original repository and create a pull request: + +1. Go to the [pull requests section](https://github.com/MudBlazor/Translations/pulls) 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](CODE_OF_CONDUCT.md). 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 Translations, you agree that your contributions will be licensed under the [MIT License](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! \ No newline at end of file diff --git a/README.md b/README.md index 6c23b4c..6fc6f23 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![NuGet](https://img.shields.io/nuget/v/MudBlazor.Translations.svg)](https://www.nuget.org/packages/MudBlazor.Translations) [![NuGet](https://img.shields.io/nuget/dt/MudBlazor.Translations.svg)](https://www.nuget.org/packages/MudBlazor.Translations) [![Translation status](https://hosted.weblate.org/widget/mudblazor/svg-badge.svg)](https://hosted.weblate.org/engage/mudblazor/) +[![Discord](https://img.shields.io/discord/786656789310865418?color=%237289da&label=Discord&logo=discord&logoColor=%237289da&style=flat-square)](https://discord.gg/mudblazor) # MudBlazor.Translations @@ -42,11 +43,15 @@ documentation page. [![Translation status](https://hosted.weblate.org/widget/mudblazor/multi-auto.svg)](https://hosted.weblate.org/engage/mudblazor/) +## License + +This project is licensed under the MIT License. See the [LICENSE](https://choosealicense.com/licenses/mit/) file for details. + ## Contributing -If you want to contribute to the translations, please visit -the [Weblate project](https://hosted.weblate.org/engage/mudblazor/). +Contributions are welcome! Please see the [CONTRIBUTING](CONTRIBUTING.md) guide for more details. -## License +## Contact + +For questions or support, please open an issue on this repository. -Distributed under the [MIT License](https://choosealicense.com/licenses/mit/). See `LICENSE` for more information.