Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

70 lines (43 loc) · 2.41 KB
Raw

Contributing Guide

General

  1. If you think something belongs in the wrong category, or think there needs to be a new category, feel free to edit things.
  2. Always add your items to the end of a list. The order is first-come-first-serve.

Articles & Tutorials

You should put your Article/Video/Tutorial in this category if the following conditions are true:

  • The Article/Video/Tutorial is about using the Flame Engine.
  • The Article/Video/Tutorial needs to have an English version or subtitles. Adding a translation for an existing article is fine.

Entries for that category should look like the following:

- [My Article](repository url) - By [Name](url)

If you have a series of articles, you are allowed to bundle them into a sub header:

### Tutorial Topic by Name
- [My Article Part 1](url)
- [My Article Part 2](url)

Plugins & Libraries

The "Official" section is reserved for the Flame Team. Please use the "Community" section to add your entry.

You should put your project in this category if the following conditions are true:

  • The project is compatible with the Flame Engine.
  • The project contains a LICENSE file.
  • The documentation README contains a description of the project, illustration of the project with a demo or screenshots.
  • The documentation README is in English.

Entries for that category should look like the following:

- [My Plugin/Library](repository url) - Short description. By [Name](url)

Projects

  1. Open Source is a great learning resource, thus publicly available projects will be listed first.
  2. Make sure to add your Game to the correct Genre.
  3. If you add a new Genre, please order them A-Z.

Open Source

You should put your project in this category if the following conditions are true:

  • Made with the Flame Engine.
  • The project contains a LICENSE file.
  • The documentation README contains a description of the project, illustration of the project with a demo or screenshots.
  • The documentation README is in English.

Entries for that category should look like the following:

- [My Game] (repository url) - Short description. By [Name](url)

App Releases

You should put your project in this category if the following conditions are true:

  • Made with the Flame Engine.
  • Published on the Google Play or Apple App Store.

Entries for that category should look like the following:

- My Game - [Android](url), [iOS](url) - Short description. By [Name](url)