Skip to content

Commit c640db8

Browse files
committed
Readme: Updated sponsorship links and language contribution info
- Updated sponsor text since it only mentioned GitHub, nothing else. - Updated translation contribution info to dissuade code-based contributions due to issues with conflicts/sync.
1 parent 49b286c commit c640db8

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

readme.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,9 @@ In regard to development philosophy, BookStack has a relaxed, open & positive ap
3939

4040
Shown below are our bronze, silver and gold project sponsors.
4141
Big thanks to these companies for supporting the project.
42-
Note: Listed services are not tested, vetted nor supported by the official BookStack project in any manner.
43-
[View all sponsors](https://github.com/sponsors/ssddanbrown).
42+
*Note: The listed services are not tested, vetted nor supported by the official BookStack project in any manner.*
43+
44+
[Project donation details](https://www.bookstackapp.com/donate/) - [GitHub Sponsors Page](https://github.com/sponsors/ssddanbrown) - [Ko-fi Page](https://ko-fi.com/ssddanbrown)
4445

4546
#### Silver Sponsors
4647

@@ -92,18 +93,19 @@ Details about BookStack's versioning scheme and the general release process [can
9293

9394
## 🌎 Translations
9495

95-
Translations for text within BookStack is managed through the [BookStack project on Crowdin](https://crowdin.com/project/bookstack). Some strings have colon-prefixed variables such as `:userName`. Leave these values as they are as they will be replaced at run-time. Crowdin is the preferred way to provide translations, otherwise the raw translations files can be found within the `resources/lang` path.
96-
Translations to original files, provided via pull request, will be fed back through Crowdin instead of being merged directly and therefore your changes & commits will not be reflected in git contribution history.
96+
Translations for text within BookStack is managed through the [BookStack project on Crowdin](https://crowdin.com/project/bookstack). Some strings have colon-prefixed variables such as `:userName`. Leave these values as they are as they will be replaced at run-time.
97+
98+
Please use [Crowdin](https://crowdin.com/project/bookstack) to contribute translations instead of opening a pull request. The translations within the working codebase can be out-of-date, and merging via code can cause conflicts & sync issues. If for some reason you can't use Crowdin feel free to open an issue to discuss alternative options.
9799

98100
If you'd like a new language to be added to Crowdin, for you to be able to provide translations for, please [open a new issue here](https://github.com/BookStackApp/BookStack/issues/new?template=language_request.yml).
99101

100102
Please note, translations in BookStack are provided to the "Crowdin Global Translation Memory" which helps BookStack and other projects with finding translations. If you are not happy with contributing to this then providing translations to BookStack, even manually via GitHub, is not advised.
101103

102104
## 🎁 Contributing, Issues & Pull Requests
103105

104-
Feel free to create issues to request new features or to report bugs & problems. Just please follow the template given when creating the issue.
106+
Feel free to [create issues](https://github.com/BookStackApp/BookStack/issues/new/choose) to request new features or to report bugs & problems. Just please follow the template given when creating the issue.
105107

106-
Pull requests are welcome. Unless a small tweak or language update, It may be best to open the pull request early or create an issue for your intended change to discuss how it will fit into the project and plan out the merge. Just because a feature request exists, or is tagged, does not mean that feature would be accepted into the core project.
108+
Pull requests are welcome but, unless it's a small tweak, it may be best to open the pull request early or create an issue for your intended change to discuss how it will fit into the project and plan out the merge. Just because a feature request exists, or is tagged, does not mean that feature would be accepted into the core project.
107109

108110
Pull requests should be created from the `development` branch since they will be merged back into `development` once done. Please do not build from or request a merge into the `release` branch as this is only for publishing releases. If you are looking to alter CSS or JavaScript content please edit the source files found in `resources/`. Any CSS or JS files within `public` are built from these source files and therefore should not be edited directly.
109111

0 commit comments

Comments
 (0)