Skip to content

Latest commit

 

History

History
188 lines (167 loc) · 6.43 KB

contributing.wiki

File metadata and controls

188 lines (167 loc) · 6.43 KB

Contributing to ryuuganime-db

Hello and thanks for taking your time to contribute!

The following is a set of guidelines for contributing to ryuuganime-db. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

Code of conduct

This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct version 2.0. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Getting started

Extensions, applications, and services used

  • Microsoft Visual Studio Code for editing.
    If you are using Visual Studio Code, you will likely get a prompt to install several recommended extensions. Please to install and use mentioned extensions.
  • MALSync for grabbing English Fanstream links.
  • animanga-wordlist for spellchecking.

Sites accessibility

Those are tables which sites are being used by this repository. Please make sure you have access to those sites.

Online databases

Favicons Sites Link Additional notes
AniDB https://anidb.net
AniList https://anilist.co
Anime-Planet https://anime-planet.com
Anime News Network https://animenewsnetwork.com
AniSearch https://anisearch.com or https://anisearch.de
Annict https://annict.com or https://annict.jp VPN or Proxy need to be enabled for Indonesian contributors
DB Fansub Indonesia by Silver Yasha https://db.silveryasha.web.id/ No English support. Only for taking Indonesian fansub links.
IMDb https://imdb.com
Kinopoisk https://kinopoisk.ru No English support.
Kitsu https://kitsu.io
LiveChart https://livechart.me
MyAnimeList https://myanimelist.net
MyShows https://en.myshows.me or https://ru.myshows.me or https://myshows.me
Nautiljon https://nautiljon.com No English support.
Notify.moe https://notify.moe
Otak Otaku https://otakotaku.com No English support.
Shikimori https://shikimori.one or https://shikimori.org Contributor need to be signed up to change language into English.
Simkl https://simkl.com
The Movie Database https://themoviedb.org
The TVDB https://thetvdb.com
Trakt https://trakt.tv
TVTime https://tvtime.com Contributors need to be signed up via their phone to gain access the site, or forcing it trough this link.

Commit and pull request

Cloning repository

To clone this repository you need Git installed on your end and the repository need to be forked to your GitHub account. From your command line:

git clone https://github.com/<YOUR USERNAME>/ryuuganime-db
Note
Remember to change <YOUR USERNAME> into your GitHub username.

Adding anime index

Read our documentation on https://wiki.ryuuganime.my.id.

Modifying MediaWiki (.wiki) documents

Read the official MediaWiki file formatting documentation from Wikimedia and Github Extension for MediaWiki Document Markups.

However, MediaWiki on GitHub is more restricted on customizations. So keep in mind that you can not make the text colored, 'kay?

Naming a file

Read our documentation on https://wiki.ryuuganime.my.id.

Commit changes

There is no strict guidelines for adding commit message. However, the best one is make it "uniform."

We commonly use those for prefix:

  • Add
    when file is untracked by git.
  • Modify or Fix
    when there some lines modified from previous.
  • Batch update
    when there are plenty of file untracked by git.
  • Update
    when some information updated.

Pulling a merge request

  1. Make sure you have required to naming your commit based on Commit changes guideline.
  2. Name your pull request as
    Detail: Comment
    Note:
    Detail
    Defining what the purpose of this pull request.
    Available arguments, at the moment:
    Add, Modify, Fix
  3. On comment section, fill any information that were required.
  4. Click on the green "Send pull request" button to finish creating the pull request.
  5. You should now see an open pull request.

Issuing Suggestion or Problem

Got a great idea or found an issue but can not executing as well, or unfamiliar with Git interface? Now, you can relax more because GitHub has a great feature, called GitHub Issue. It helps users to "interact" developers with 0 knowledge of coding.

You can send us an issue for we can look for it.