Skip to content

Commit

Permalink
Add link to resource file docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bradymholt authored Jul 10, 2024
1 parent fb1c5a9 commit 6fcd3aa
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Thanks for being willing to contribute!

If you are adding a language translation you will need to do the following:

1. Determine the language culture name (LCN) to use. You can reference [Table of Language Culture Names, Codes, and ISO Values Method](https://msdn.microsoft.com/en-us/library/ee825488(v=cs.20).aspx) for help.
1. Determine the language culture name (LCN) to use. You can reference [Table of Language Culture Names, Codes, and ISO Values Method](https://msdn.microsoft.com/en-us/library/ee825488(v=cs.20).aspx) for help. More information about Resource files can be found [here](https://learn.microsoft.com/en-us/dotnet/core/extensions/localization#resource-files).
2. Add a `Resources.[LCN].resx` file than provides the translation. You can use one of the existing ones as a pattern. In general, please use only the first part of the culture name which denotes the language itself and not the country/region. This will allow the translation to be used more widely. However, if the language is very much specific to a country/region then using the second part of of the name is appropriate. For example, there are 5 culture names for Germany (de-AT, de-DE, dr-LI, de-LU, de-CH) but we only have a resource file named `Resources.de.resx`. This allows this translation to be used for any of the specific culture names that would be passed in at runtime. However, for Chinese, we have `Resources.zh-CN.resx` defined because the translation is Chinese Simplified and specific to China itself.
3. Create a TestsFormats.[LCN].cs file in CronExpressionDescriptor.Test project with tests for the translation. You can use one of the existing test files as a pattern.
4. Add the translation to the `README.md` i18n list and the <Description/> section of the CronExpressionDescriptor/CronExpressionDescriptor.csproj file
Expand Down

0 comments on commit 6fcd3aa

Please sign in to comment.