Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 2.83 KB

contributing.md

File metadata and controls

58 lines (39 loc) · 2.83 KB
Raw

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Adding an new Item

Either use the GitHub online editor tool or clone to your local machine. Always create a new branch and PR!

  • Try to fit your item into an existing sections. Open a suggestion to start as discussion about any new sections.
  • Add a new item to the bottom of the list in a section.
  • If a duplicate item exists, discuss why the new item should replace it.
  • Check your spelling & grammar.
  • The item must follow this format: 
    - :legend emoji: [item name](https link) - Description beginning with capital, ending in period.

Valid Sources

Roughly speaking, a source is considered valid if - it could be used by a development team or beginner today on a new Firebase project and not lead them astray.

An item is NOT valid if:

  • it is an archived GitHub (or other) repository
  • it is an outed project that is no longer actively maintained AND it's the type of project that requires maintenance. Eg: minimist is an unmaintained project but it would still qualify as it doesn't particularly require maintenance.

An item can still be VALID if:

  • it is a heavily used project/article (npm downloads being one metric)
  • it is a heavily referenced project/article

Languages

We should aim to support all languages that the Firebase docs support. At the time of writing this is:

  • KO: 한국어
  • ZH-CN: 简体中文
  • JA: 日本語
  • PT-BR: Português Brasileiro
  • ES-419: Español (América Latina)
  • EN: English
  • ID: Bahasa Indonesia

If you wish to see this list in another language, please create a PR with translations for items where you can. There is already some boilerplate for the aforementioned languages in the README lines 12-20.

For languages not in the above list.

  • Create a README suffixed with your language code. Eg: readme-ko.md for Korean.
  • Add your language code to the list at the top of the root english (README.md lines 12-20).

Adding a non-English item to the English README

If you are adding an item that is not english, please translate the item name and description to english, but include the language code between the emoji and item name so readers know the language of the resource before heading there.

- 🔌 ko [item name](https link) - Description beginning with capital, ending in period.
- 🔌 ja [item name](https link) - Description beginning with capital, ending in period.