diff options
| author | 2019-12-03 22:37:40 +0100 | |
|---|---|---|
| committer | 2019-12-03 22:37:40 +0100 | |
| commit | 705318aa39a605a4d869db588f6cffb12019a611 (patch) | |
| tree | 36383dfee24999f9928957621b655e67b20714b7 /docs/en/contributing.md | |
| parent | 0de7e84380dff5222e6728aacbbb42abaac51dd9 (diff) | |
Translate docs with po4a (#2590)
* [i18n] Add docs po4a script
* Add proof of concept
* Add a few more translations
* Hush ShellCheck and shfmt
* Make that list po4a-friendly
* drat, this document could've probably been auto-generated
* Definitive proof that it's translated from French ;-)
* Add some brand spanking new French translation
* More translation
* Mostly finish that config page
* Fix up FAQ
* More contributing
* Dev first steps
* Let's ignore that admin stuff at the very least for now
* Translate release new version, make French the source first and copy all translations
Then replace French with English in the source.
Much quicker than any alternative route.
* And add the English translation
* Minor stylistic leftover from French
* Most of first steps
* Forgot the extensions
* Use po4a 0.56 to get rid of way too many newlines
* Fix up those newlines
* No point linking to Firefox integration anymore from the new user guide
* Start on main view
* A bunch of main view stuff
* More main view
* And some subscriptions before going to bed
* First steps for devs
* More dev first steps
* Incomplete French → English dev/GH translation
Because I need to ask about that mailing list thing
* Fix typo in docs/en/developers/02_Github.md
* Translate & complete devs/github to English
* Fix up most of extensions
* Is that supposed to be a non-breaking space? Let's see
* Match up some users/mobile access
* More users/mobile access
* Add fresh French translation to Fever API
* Fix typo
* Match frontend todo thingies
* Fix a typo
* Some extensions strings
* Remove Fx subscription service from the docs
Cf. https://github.com/FreshRSS/FreshRSS/pull/2606
* Add translation for https://github.com/FreshRSS/FreshRSS/pull/2643
* fix typo as per https://github.com/FreshRSS/FreshRSS/pull/2643#discussion_r345433009
* Add some more French translations
* Update French translation as per @aledeg comment https://github.com/FreshRSS/FreshRSS/pull/2590#discussion_r345465909
* Translate some of the meaningless stuff
* Translate the rest of contributing.md to French
* Fix conflicts
* Translate Docker first steps to French
* Update with change from #2665
* Add @aledeg corrections
* Overlooked a couple @aledeg corrections thanks to GitHub autohide
* Latest @aledeg suggestions
Diffstat (limited to 'docs/en/contributing.md')
| -rw-r--r-- | docs/en/contributing.md | 38 |
1 files changed, 20 insertions, 18 deletions
diff --git a/docs/en/contributing.md b/docs/en/contributing.md index 870e0c14f..b06680e02 100644 --- a/docs/en/contributing.md +++ b/docs/en/contributing.md @@ -2,39 +2,41 @@ Do you want to ask us some questions? Do you want to discuss with us? Don't hesitate to subscribe to our mailing lists! -- The first mailing is destined to generic information, it should be adapted to users. [Join mailing@freshrss.org](https://freshrss.org/mailman/listinfo/mailing). -- The second mailing is mainly for developers. [Join dev@freshrss.org](https://freshrss.org/mailman/listinfo/dev) +* The first mailing is destined to generic information, it should be adapted to users. [Join mailing@freshrss.org](https://freshrss.org/mailman/listinfo/mailing). +* The second mailing is mainly for developers. [Join dev@freshrss.org](https://freshrss.org/mailman/listinfo/dev) ## Report a bug -You found a bug? Don't panic, here are some steps to report it easily: +Have you found a bug? Don't panic, here are some steps to report it with ease: 1. Search for it on [the bug tracker](https://github.com/FreshRSS/FreshRSS/issues) (don't forget to use the search bar). 2. If you find a similar bug, don't hesitate to post a comment to add more importance to the related ticket. 3. If you didn't find it, [open a new ticket](https://github.com/FreshRSS/FreshRSS/issues/new). -If you have to create a new ticket, try to apply the following advices: +If you have to create a new ticket, please try to keep in mind the following advice: -- Give an explicit title to the ticket so it will be easier to find it later. -- Be as exhaustive as possible in the description: what did you do? What is the bug? What are the steps to reproduce the bug? -- We also need some information: - + Your FreshRSS version (on about page or `constants.php` file) - + Your server configuration: type of hosting, PHP version - + Your storage system (SQLite, MySQL, MariaDB, PostgreSQL) - + If possible, the related logs (PHP logs and FreshRSS logs under `data/users/your_user/log.txt`) +* Give an explicit title to the ticket so it will be easier to find it later. +* Be as exhaustive as possible in the description: what did you do? What is the bug? What are the steps to reproduce the bug? + +We also need some information: + +* Your FreshRSS version (on the about page or in the `constants.php` file) +* Your server configuration: the type of hosting and the PHP version +* Your storage system (SQLite, MySQL, MariaDB, PostgreSQL) +* If possible, the related logs (PHP logs and FreshRSS logs under `data/users/your_user/log.txt`) ## Fix a bug -Did you want to fix a bug? To keep a great coordination between collaborators, you will have to follow these indications: +Would you like to fix a bug? For optimum coordination between collaborators, you should follow these indications: -1. Be sure the bug is associated to a ticket and say you work on it. -2. [Fork this project repository](https://help.github.com/articles/fork-a-repo/). -3. [Create a new branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/). The name of the branch must be explicit and being prefixed by the related ticket id. For instance, `783-contributing-file` to fix [ticket #783](https://github.com/FreshRSS/FreshRSS/issues/783). +1. Be sure the bug is associated with a ticket and indicate that you'll work on it. +2. [Fork the project repository](https://help.github.com/articles/fork-a-repo/). +3. [Create a new branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/). The name of the branch should be clear, and ideally prefixed by the related ticket id. For instance, `783-contributing-file` to fix [ticket #783](https://github.com/FreshRSS/FreshRSS/issues/783). 4. Make your changes to your fork and [send a pull request](https://help.github.com/articles/using-pull-requests/) on the **dev branch**. If you have to write code, please follow [our coding style recommendations](developers/01_First_steps.md). -**Tip:** if you are searching for easy-to-fix bugs, have a look at the « [good first issue](https://github.com/FreshRSS/FreshRSS/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) » ticket label. +**Tip:** if you're searching for easy-to-fix bugs, please have a look at the "[good first issue](https://github.com/FreshRSS/FreshRSS/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)" ticket label. ## Submit an idea @@ -44,11 +46,11 @@ If your idea is nice, we'll have a look at it. ## Contribute to internationalization (i18n) -If you want to improve internationalization, please open a new ticket first and follow indications from « Fix a bug » section. +If you want to improve internationalization, please open a new ticket first and follow the advice from the *Fix a bug* section. Translations are present in the subdirectories of `./app/i18n/`. -We are working on a better way to handle internationalization but don't hesitate to suggest any idea! +We're working on a better way to handle internationalization, but don't hesitate to suggest any ideas! ## Contribute to documentation |
