Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Contribution Guideline #3

Open
Quorafind opened this issue Oct 18, 2024 · 4 comments
Open

[Doc] Contribution Guideline #3

Quorafind opened this issue Oct 18, 2024 · 4 comments

Comments

@Quorafind
Copy link

Hi there!

It would be great to include some contribution guidelines for the templates. This might cover things like naming conventions when adding templates to the repository, whether usage instructions should be included, and if any adjustment guidelines are necessary.

@sigrunixia
Copy link
Collaborator

This also has some crossover with #1 .

@esodesod
Copy link
Collaborator

Totally agree! I've added some comments in the discussion #1 (comment), mainly related to naming conventions.

Adding instructions to some of the templates is highly relevant as well, e.g. one will need to click on the "view transcript"-button on youtube videos to load the transcript, and for the clipper to actually be able to extract the transcript.

@sigrunixia
Copy link
Collaborator

Adding instructions to some of the templates is highly relevant as well, e.g. one will need to click on the "view transcript"-button on youtube videos to load the transcript, and for the clipper to actually be able to extract the transcript.

Agreed. Seeing the comments in #4 , we and the end template user should know going in if this template is build around a certain plugin usage as well.

@DudeThatsErin
Copy link
Contributor

Once this gets straightened out, I have more time on my hands now (got laid off again -.-) so I can write up some docs for the help site. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants