-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create a separate CONTRIBUTING.md (#6)
- Loading branch information
1 parent
adac1b4
commit 1b820d6
Showing
2 changed files
with
104 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters