Skip to content

Latest commit

 

History

History
54 lines (29 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

54 lines (29 loc) · 1.8 KB

Welcome

I really enjoy contributing open-source so I'm glad you want to help with the project

There are some rules here for your issue/pull request to be accepted so let's go

Issue

The issue have to be in this format, put a title that has to do with the issue and that briefly describes the problem/suggestion describing your problem, the operating system and your library versions and what you have already tried to do

issue-way

pull request

make a title that briefly describes what you did and inform the issue if it solves it or has something to do with it, if it supports a fansub, describe the name and your language also describe which modules were changed and if possible what changed in each one

pull-request-way

content

This is what has to be generated for the user:

  • a README.txt file with the name of the Fansub, your logo if have and the link of your site/page in web

header

  • a summary.txt file with the sequence of read named: summary - {titleVolume}

summary

  • a image of cover of volume

cover

  • a subfolder named: ilustrations, with all ilustrations of the novel

pdf file

if a user content a pdf file the following items have to be generated in the folder of volume:

pdf-choose

  • pdf file with all the content of the current volume named: {titleVolume}.pdf pdf-novel

txt file

if a user content a txt file the following items have to be generated in the folder of volume:

txt-choise

  • a txt file with all the content of the current volume named: {titleVolume}.txt txt-novel