Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 4.41 KB

CONTRIBUTING.md

File metadata and controls

66 lines (49 loc) · 4.41 KB

Contribution guidelines

Please read the FAQ down below.

Possible errors / problems in the database

If you find something that, in your opinion, could be the result of incorrectly extacted data, please submit an issue rather than creating a pull request, because the database is created by an automated process.

Adding your project to the list of projects using this database

In case you have a project that uses this database and you want to add it to the list of projects that are using this database, create a pull request adding it to the table. Do not create an issue asking me or anyone else to add it.

  • You have to be the author/maintainer of the project that you want to add
  • Create a PR in which you add it to the table in the README.md
  • Do not change/alter anything else
  • Your project has to use this database
  • You have to have a link back to this project in the README.md of your project
  • The README.md of your project has to be in english or it must have an english translation
  • Your project has to be hosted either on github or gitlab
  • The table is sorted by project name (ascending). Add your entry accordingly.
  • Project name must match the repository name and link directly to the source code (not a project page such as YOURNAME.github.io)
  • Put your name under Author/Maintainer with a link to your profile.
  • Add a meaningful description in english. The description must not be longer than 150 characters.

FAQ

What do you mean by 'meta data provider'?

Websites which provide information about anime such as myanimelist.net, notify.moe, ...

Can you please add additional information?

No. The data set has been created for my own tool. It contains all information that I need and I won't add any further information. This is merely an index. The idea is to visit the meta data provider of your choice to get additional information about the anime.

Can you please add an additional meta data provider?

No. I don't plan to add any additional meta data provider.

Can you please change the structure of the file?

No. The file has the structure that it needs to have for the purpose it has been built for.

There are duplicates in the data set.

If the entry of one meta data provider is not merged with an entry of a different meta data provider, although they are practically the same entry, then this is not a duplicate. They are simply not merged together. This can happen and it is intentional. Since this data set is created automatically two entries should rather not be merged than falsely merged together. If you query this data set based on titles/synonyms it might seem that there are duplicates. However the intended usage is to query by the url of the meta data provider. This way you will always retrieve the entry that you want. Entries being merged together is just a nice to have.

A duplicate by defintion of this data set is an entry which contains multiple links of the same meta data provider in sources.

Why are there no IDs?

There are. The entries under sources are the IDs. Each one of the array's URLs is a key for that specific entry.

Is this data set created automatically or manually?

It is created automatically and reviewed in a half-automated process.

Do you plan to open source the code which creates this data set?

Yes. However there is still work todo before I can/want to open source it and that doesn't have any priority right now.

How do you split entries?

Entries are split if one meta data provider lists multiple entries as one and others don't. Example:

  • The entry of a meta data provider which lists 3 Movies as one entry is split from three separate entries of another meta data provider
  • A series is listed as one entry having 26 episodes on one meta data provider and as two entries having 13 episodes each on the other meta data provider

However if one entry is listed with 13 episodes whereas the other is listed with 12, because it doesn't count the recap episode then these entries are still merged together.

Can I somehow contribute?

Currently I can't think of a way.

Does this data set contain all anime from the supported meta data provider?

No. MAL is the only provider that lists 18+ titles publicly. So these titles are missing for the other meta data providers. If there are new entries which have been created after an update then those obviously won't appear until the next update. Apart from that it should contain all titles from the supported meta data provider.