contributing.wiki

Contributing to animanga-wordlist

Hello and thanks for taking your time to contribute!

The following is a set of guidelines for contributing to animanga-wordlist. 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 Contributing to animanga-wordlist Code of Conduct Getting Started Extensions, Applications, and Services Used Sites Accessibility Commit and Pull Request Cloning Repository Naming a File Commit Changes Pulling a Merge Request Issuing Suggestion or Problem Issuing Suggestion Issuing Problem

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 contact@ryuuganime.my.id.

Getting Started

Extensions, Applications, and Services Used

• Web Scraper for Google Chrome Browser to scraping HTML data from sites.
• Microsoft Office 365 Excel for removing duplicates and sorting as A-Z.
• Gunamoi Software SaveJson2CSV for converting from JSON to CSV (ANSI encoding).
• Microsoft Visual Studio Code for MediaWiki editing.
• Ron's CSV Editor for CSV editor.

Sites Accessibility

As we mentioned on readme.wiki, we using several website for scraping data. Make sure you have an access to the site, or use API to access.

This is a table which sites are being and can not be used by this repository:

Sites	Link	Used data	Scraping
AniDB	https://anidb.net	anime, characters	Scrape-able with extension
AniList	https://anilist.co	Work in Progress	Need to use API for scraping
anime-offline-database	https://github.com/manami-project/anime-offline-database	anime	Convert from JSON to CSV
Anime-Planet	https://anime-planet.com	anime, manga, studios	Scrape-able with extension
Anime News Network	https://animenewsnetwork.net	Null	Un-scrape-able
AniSearch	https://anisearch.com or https://anisearch.de	anime, manga, characters	Scrape-able with extension
Kitsu	https://kitsu.io	Work in Progress	Need to use API for scraping
MyAnimeList	https://myanimelist.net	anime, manga	Scrape-able with extension
Notify.moe	https://notify.moe	Work in Progress	Need to use API for scraping
Shikimori	https://shikimori.one or https://shikimori.org	anime, manga	Scrape-able with extension

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>/animanga-wordlist

Naming a File

There is simple guideline for naming a file:

category/siteName-date.ext

Note:

category

Defining which data are scraped of what category.
Available arguments:

anime, casts, charas, manga, producers, sites, and studios.

siteName

Defining which site used for scraping data. Using camelCase.
Available arguments, at the moment:

aniDb, aniList, animePlanet, animeNewsNetwork, aniSearch, aod, kitsu, myAnimeList, notifyMoe, and shikimori.

date

Defining when data was scraped from site. Using MMYYYY pattern.

ext

Defining what file extension being used. Default: plain text format (.txt)

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:

   Definition, Category, Fix

3. Click on the green "Send pull request" button to finish creating the pull request.
4. 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.

Issuing Suggestion

1. Open ryuuganime/animanga-wordlist/issues and tap on New Issue button.
2. In title bar, write:
   

   Suggestion: <your comment>

3. Adding additional comment/information would helps us figuring out what you want to suggest with.
4. If you finished writing issue, tap Submit new issue.
5. You should now see an open issue.

Issuing Problem

1. Open ryuuganime/animanga-wordlist/issues and tap on New Issue button.
2. In title bar, write:
   

   <your comment>

3. Adding additional comment/information would helps us figuring out what problem(s) is/are occurred.
4. If you finished writing issue, tap Submit new issue.
5. You should now see an open issue.