From 818ac228a0dfef61cc8a4c302975af6bb874dc40 Mon Sep 17 00:00:00 2001 From: Natsu Tadama Date: Fri, 3 Jul 2020 16:53:23 +0700 Subject: [PATCH] Update contributing guideline --- CODE_OF_CONDUCT.wiki | 1 + contributing.wiki | 54 ++++++++++++++++++++++++++++++-------------- readme.wiki | 12 +++++----- 3 files changed, 44 insertions(+), 23 deletions(-) diff --git a/CODE_OF_CONDUCT.wiki b/CODE_OF_CONDUCT.wiki index d73db11..131324b 100644 --- a/CODE_OF_CONDUCT.wiki +++ b/CODE_OF_CONDUCT.wiki @@ -1,4 +1,5 @@ = Contributor Covenant Code of Conduct = + __TOC__ == Our Pledge == diff --git a/contributing.wiki b/contributing.wiki index d2a3ea9..15493dc 100644 --- a/contributing.wiki +++ b/contributing.wiki @@ -6,16 +6,16 @@ The following is a set of guidelines for contributing to animanga-wordlist. Thes __TOC__ == Code of Conduct == -This project and everyone participating in it is governed by the [[CODE_OF_CONDUCT.wiki|Contributor Covenant Code of Conduct version 2.0]]. By participating, you are expected to uphold this code. Please report unacceptable behavior to [mailto:nattadasu@my.com nattadasu@my.com]. +This project and everyone participating in it is governed by the [[CODE_OF_CONDUCT.wiki|'''Contributor Covenant Code of Conduct version 2.0''']]. By participating, you are expected to uphold this code. Please report unacceptable behavior to [mailto:nattadasu@my.com nattadasu@my.com]. == Getting Started == === Extensions, Applications, and Services Used === -* [https://webscraper.io/ Web Scraper] for Google Chrome Browser to scraping HTML data from sites. -* Microsoft Office 365 Excel for removing duplicates and sorting as A-Z. -* [https://www.gunamoi.com.au/soft/savejson2csv/index.html Gunamoi Software SaveJson2CSV] for converting from JSON to CSV (ANSI encoding). -* [https://code.visualstudio.com/ Microsoft Visual Studio Code] for MediaWiki editing. -* Ron's CSV Editor for CSV editor. +*[https://webscraper.io/ Web Scraper] for Google Chrome Browser to scraping HTML data from sites. +*Microsoft Office 365 Excel for removing duplicates and sorting as A-Z. +*[https://www.gunamoi.com.au/soft/savejson2csv/index.html Gunamoi Software SaveJson2CSV] for converting from JSON to CSV (ANSI encoding). +*[https://code.visualstudio.com/ 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. @@ -91,18 +91,18 @@ category/siteName-date.ext '''Note''': ;category -: Defining which data are scraped of what category.
Available arguments: -:: anime, casts, charas, manga, producers, sites, and studios. +: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 [https://en.wikipedia.org/wiki/Camel_case camelCase].
Available arguments, at the moment: -:: aniDb, aniList, animePlanet, animeNewsNetwork, aniSearch, aod, kitsu, myAnimeList, notifyMoe, and shikimori. +:Defining which site used for scraping data. Using [https://en.wikipedia.org/wiki/Camel_case 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. +:Defining when data was scraped from site. Using MMYYYY pattern. ;ext -: Defining what file extension being used. Default: plain text format (.txt) +: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." @@ -120,10 +120,30 @@ We commonly use those for prefix: === Pulling a Merge Request === -# Make sure you have required to naming your commit based on Commit Changes guideline. -# Name your pull request as
Detail: Comment
'''Note''': -#; Detail +#Make sure you have required to naming your commit based on Commit Changes guideline. +#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 -# Click on the green "Send pull request" button to finish creating the pull request. -# You should now see an open pull request. \ No newline at end of file +#Click on the green "Send pull request" button to finish creating the pull request. +#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 [https://github.com/ryuuganime/animanga-wordlist/issues 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 === +#Open '''[https://github.com/ryuuganime/animanga-wordlist/issues ryuuganime/animanga-wordlist/issues]''' and tap on '''[https://github.com/ryuuganime/animanga-wordlist/issues/new New Issue]''' button. +#In title bar, write:
Suggestion:
+#Adding additional comment/information would helps us figuring out what you want to suggest with. +#If you finished writing issue, tap '''Submit new issue'''. +#You should now see an open issue. + +=== Issuing Problem === +#Open '''[https://github.com/ryuuganime/animanga-wordlist/issues ryuuganime/animanga-wordlist/issues]''' and tap on '''[https://github.com/ryuuganime/animanga-wordlist/issues/new New Issue]''' button. +#In title bar, write:
+#Adding additional comment/information would helps us figuring out what problem(s) is/are occurred. +#If you finished writing issue, tap '''Submit new issue'''. +#You should now see an open issue. \ No newline at end of file diff --git a/readme.wiki b/readme.wiki index 15e7e47..23b3469 100644 --- a/readme.wiki +++ b/readme.wiki @@ -2,20 +2,20 @@ Designed for custom dictionary. This repository allows user to add Japanese (and overseas, in the future) animations, comics, novels, characters, casts, producers, and studios words to their personalized spell correction extension nor app. At the moment, we only include romaji (romanized) script for wordlist; Kanji and other script may be listed in the future. +__TOC__ + This repo consists at least, so far: -* '''33283''' [[/anime|anime]] titles, +* '''32843''' [[/anime|anime]] titles, * '''94644''' [[/manga|manga]] titles, * '''518''' [[/studios|studios]], * '''#####''' [[/producers|producers]], -* '''116972''' [[/charas|characters]], +* '''86177''' [[/charas|characters]], * '''#####''' [[/casts|seiyuus/casts]], and * '''253''' [[/sites|official streaming and information sites]] indexed. ;'''NOTE''' : Those dictionaries is duplicate-free and directly scraped from sites without filtering, and some data can be exact same each other since each site do have their own romanization rule for title. Numbers of how much entries included can not be a reference or source for work(s) which required for citing statistical information. -__TOC__ - == Scraping Information == We currently scraping those words directly from sites using [https://chrome.google.com/webstore/detail/web-scraper/jnhgnonknehpejjnehehllkliplmbmhn Web Scraper] extension. @@ -40,13 +40,13 @@ Latest update on June 25, 2020, 9:29 PM Western Indonesian Time (UTC+7, Asia/Jak == File Information == -We using plain text format (.txt and .rydict) for dictionaries, and MediaWiki file format (.wiki, .mediawiki) for README and some important information. JSON and YAML files are intended to be used for the machines only. +We using plain text format (.txt and .rydict) for dictionaries, and MediaWiki file format (.wiki, .mediawiki) for README and some important information. JSON, YAML, and Markdown (.md) files are intended to be used for the machines and GitHub only. === About .rydict === .rydict is a self-curated wordlist collected from several sources and implement into one file by Ryuuganime itself using plain text format (.txt). Basically helps dictionary/spelling checker extension/app from overhaul by the resources, so it can reduce a lot of memory consumed by the app/extension. -== Cloning, Issuing, and Contributing == +== Cloning, Contributing, and Issuing Suggestion/Problem == Please read [[contributing.wiki]] for more detailed information. == Code of Conduct ==