Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Translations #1907

Merged
merged 7 commits into from
Mar 9, 2021
Merged

Add Translations #1907

merged 7 commits into from
Mar 9, 2021

Conversation

niedev
Copy link
Contributor

@niedev niedev commented Nov 16, 2020

https://github.com/mbiesiad/awesome-translations

This list contains libraries, platforms, apps and articles about translation and localization. This list should be included because languages are barriers for people, and such a list can help a little to bridge those barriers by helping developers localize their apps, introducing new translation technologies and new projects in this field.

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

Requirements for your pull request

  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
  • You have to review at least 2 other open pull requests.
    Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List.
    • Add Swift
    • Add Software Architecture
    • Update readme.md
    • Add Awesome Swift
    • Add swift
    • add Swift
    • Adding Swift
    • Added Swift
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
    • - [iOS](…) - Mobile operating system for Apple phones and tablets.
    • - [Framer](…) - Prototyping interactive UI designs.
    • - [iOS](…) - Resources and tools for iOS development.
    • - [Framer](…)
    • - [Framer](…) - prototyping interactive UI designs
  • Your entry should be added at the bottom of the appropriate category.
  • The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it.
  • Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • The default branch should be named main, not master.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • Mobile operating system for Apple phones and tablets.
    • Prototyping interactive UI designs.
    • Resources and tools for iOS development.
    • Awesome Framer packages and tools.
  • It's the result of hard work and the best I could possibly produce.
    If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
    • awesome-swift
    • awesome-web-typography
    • awesome-Swift
    • AwesomeWebTypography
  • The heading title of your list should be in title case format: # Awesome Name of List.
    • # Awesome Swift
    • # Awesome Web Typography
    • # awesome-swift
    • # AwesomeSwift
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
      • Can be placed centered if the list has a centered graphics header.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of nested lists, preferably none.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Doesn't use hard-wrapping.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.
  • Doesn't include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Go to the top and read it again.

@niedev
Copy link
Contributor Author

niedev commented Nov 16, 2020

@niedev
Copy link
Contributor Author

niedev commented Nov 16, 2020

unicorn

@niedev niedev changed the title Add Translation Add Translations Nov 16, 2020
@sindresorhus
Copy link
Owner

Thanks for making an Awesome list! 🙌

It looks like you didn't read the guidelines closely enough. I noticed multiple things that are not followed. Try going through the list point for point to ensure you follow it. I spent a lot of time creating the guidelines so I wouldn't have to comment on common mistakes, and rather spend my time improving Awesome.

The description now describes the argument of the list, not the list itself.
@niedev
Copy link
Contributor Author

niedev commented Nov 16, 2020

I updated the description in the awesome readme to describe the argument, not the list.
I sent a pull request to delete the Code of Conduct title, move the link to Contributing and update the description, I think the owner will accept it soon.

Meanwhile, I have some questions:

  • Closed source items are fine or are they considered without documentation and therefore must be moved to a different markdown file?
  • Is it ok to end a description with a question mark? (awesome-lint does not report it as an error)

@niedev
Copy link
Contributor Author

niedev commented Nov 16, 2020

The pull request with the changes has been accepted.

@michelpereira
Copy link
Contributor

Added a PR to add:
Python i18n package mbiesiad/awesome-translations#11

readme.md Outdated
@@ -715,6 +715,7 @@
- [WP-CLI](https://github.com/schlessera/awesome-wp-cli#readme) - Command-line interface for WordPress.
- [Credit Modeling](https://github.com/mourarthur/awesome-credit-modeling#readme) - Methods for classifying credit applicants into risk classes.
- [Ansible](https://github.com/KeyboardInterrupt/awesome-ansible#readme) - A Python-based, open source IT configuration management and automation platform.
- [Translations](https://github.com/mbiesiad/awesome-translations#readme) - Tools to help with localization and translation.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your entry here should include a short description about the project/theme of the list. It should not describe the list itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the description, tell me if it's okay now

@sindresorhus
Copy link
Owner

I think the list is misnamed. It's not generally about translations, but specifically about translation tools.

@sindresorhus
Copy link
Owner

Generally, I think the list needs more work.

Updated the description to follow the guidelines.
@niedev
Copy link
Contributor Author

niedev commented Dec 13, 2020

Sorry, the description I wrote was wrong. In fact, the list not only contains tools for translation and localization but also articles that explain how to perform the localization of sites, apps, programs, etc. And in general about what localization, internationalization and globalization are (l10n, i18n and g11n), these days however we will add articles on translation and other elements to the list (which is not very long anyway and grows slowly because it contains only the best on these topics, not all, adhering to your guidelines for an awesome list).

@sindresorhus
Copy link
Owner

Item descriptions should not be title-case.

@sindresorhus
Copy link
Owner

Includes a succinct description of the project/theme at the top of the readme. (Example)

The current description is not good enough.

@sindresorhus
Copy link
Owner

(T9n, l10n, g11n, m17n, i18n).

You should explain all those acronyms.

@sindresorhus
Copy link
Owner

Awesome platforms => Platforms

@sindresorhus
Copy link
Owner

This blog is moot when the item is in a "Blogs" section.

@sindresorhus
Copy link
Owner

@mbiesiad
Copy link

Hi All.

Fixed: ✅ e-mail update, ✅ platforms section, ✅ acronyms, ✅ title-case, ✅ blog' descr. prefix, ✅ main descr.
@niedev Could you take a look now? I will be grateful. Best wishes,

@niedev
Copy link
Contributor Author

niedev commented Dec 20, 2020

Now everything seems ok to me too, we have also added some books to the list.

readme.md Outdated
@@ -715,6 +715,7 @@
- [WP-CLI](https://github.com/schlessera/awesome-wp-cli#readme) - Command-line interface for WordPress.
- [Credit Modeling](https://github.com/mourarthur/awesome-credit-modeling#readme) - Methods for classifying credit applicants into risk classes.
- [Ansible](https://github.com/KeyboardInterrupt/awesome-ansible#readme) - A Python-based, open source IT configuration management and automation platform.
- [Translations](https://github.com/mbiesiad/awesome-translations#readme) - Adaptation of a text or a speech from one language to many others.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you could come up with a better description on what "translation" is.


one language to many others.

It doesn't have to be "many others". It could be one other.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wrote more options and variants

  • "Transfer of the meaning of a text from one language to another."
  • "The transfer of the meaning of a text from one language to another."
  • "The process of translating words or text from one language into another." - From Oxford English Dictionary
  • "Translation is the communication of the meaning of a source-language text by means of an equivalent target-language text." - Wikipedia
  • "The communication of the meaning of a source-language text by means of an equivalent target-language text."
  • "Communication of the meaning of a source-language text by means of an equivalent target-language text."

Tell me if there is one you like.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would go with:

The transfer of the meaning of a text from one language to another.

@sindresorhus
Copy link
Owner

Linkify all the terms in (T9n - translation, l10n - localization, g11n - globalization, m17n - multilingualization, i18n - internationalization). to their Wikipedia article or similar.

@sindresorhus
Copy link
Owner

The link and description are separated by a dash.

@sindresorhus
Copy link
Owner

You need to fix the merge conflict.

@sindresorhus
Copy link
Owner

❯ awesome-lint 'https://github.com/mbiesiad/awesome-translations'
✖ Linting

  README.md:94:234
  ✖  70:77   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  87:80   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  94:234  "’" is used without matching "‘"                              remark-lint:match-punctuation
  ✖  96:266  "’" is used without matching "‘"                              remark-lint:match-punctuation

  4 errors

https://github.com/sindresorhus/awesome-lint

@niedev
Copy link
Contributor Author

niedev commented Mar 7, 2021

Fixed everything except the description and the merge conflict (I will fix both after I get feedback on description) @sindresorhus.

@niedev
Copy link
Contributor Author

niedev commented Mar 9, 2021

Done everything.

@sindresorhus sindresorhus merged commit 25449c0 into sindresorhus:main Mar 9, 2021
@sindresorhus
Copy link
Owner

Tweet: https://twitter.com/awesome__re/status/1369324519387783176

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants