From b4354d111ab7ffa8f88adc95ad5f80566446b70f Mon Sep 17 00:00:00 2001 From: 0ko <0ko@noreply.codeberg.org> Date: Wed, 10 Apr 2024 23:49:50 +0500 Subject: [PATCH] Developer: Base localization: add Contributing section --- docs/developer/localization-english.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/developer/localization-english.md b/docs/developer/localization-english.md index 6b0a990c..e0012e45 100644 --- a/docs/developer/localization-english.md +++ b/docs/developer/localization-english.md @@ -27,3 +27,19 @@ All strings should have regular capitalization. Headers, labels, buttons and suc | Button | Add Cleanup Rule | Add cleanup rule | | Label | Integrate matrix into your repository. | Integrate Matrix into your repository. | | Label | %s Commits | %s commits | + +## Contributing + +This section is to help you contribute to the English localization of Forgejo. + +### Suggesting improvements + +You send bugs, suggestions and feedback via Forgejo [issue tracker](https://codeberg.org/forgejo/forgejo/issues) or Forgejo Localization [Matrix chatroom](https://matrix.to/#/#forgejo-localization:matrix.org). Comments on Weblate also might work but are not recommended because they're checked rarely and might not be noticed. + +### Proposing changes + +Similarly to other projects you can propose changes via a pull request. Read the informative sections for string managing and style guidelines above. You can perform small changes via Forgejo web UI. Otherwise you can make a fork or use AGit workflow, clone, checkout a new branch, make your changes, commit, push and open a pull request. Put some useful explanation of the change in the PR description. Screenshots are also highly welcome. + +If it's a small change to the string, you don't need to test it locally. However, if you want to make larger text refactor, consider verifying that everything looks good together in live by building and running Forgejo locally. See [For contributors](https://forgejo.org/docs/latest/developer) for more information how to do this. + +If your refactor affects key names, make sure to perform a mass-rename of the affected keys in all code, templates and translations. Sometimes keys are generated in code with conditions. Please check for that as well. With such refactor you might be asked to resolve merge conflicts before your PR can be merged. If you have low availability, it is best to avoid renaming transltation keys.