NewPipeExtractor icon indicating copy to clipboard operation
NewPipeExtractor copied to clipboard

Create CONTRIBUTING.md file

Open triallax opened this issue 4 years ago • 10 comments

This should probably copy most of https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md save for NewPipe-specific parts.

Some other things to note:

  • No Kotlin is allowed in the codebase

triallax avatar Aug 04 '21 17:08 triallax

Can we just copy NP's file over?

opusforlife2 avatar Aug 16 '22 17:08 opusforlife2

I guess that would work, but then we would need to sync the two versions together, right?

Another option is to share the same contributing guidelines, but note when guidelines differ between the two projects. Yet another option (that I do not prefer) is to link to the NewPipe guidelines in NPE, and then state the differences.

triallax avatar Aug 16 '22 18:08 triallax

Hmmm. Syncing seems like it would be an effort to set up. I would go with the least complicated option of linking the URL and noting the differences.

opusforlife2 avatar Aug 16 '22 18:08 opusforlife2

What say?

opusforlife2 avatar Aug 19 '22 21:08 opusforlife2

Sharing the contributing guidelines between both projects is a better idea in my opinion, as the idea of linking to the NP guidelines in the NPE guidelines might cause the NPE guidelines to get outdated.

triallax avatar Aug 19 '22 21:08 triallax

My understanding is that some sort of GH Action would need to be set up to keep them in sync.

opusforlife2 avatar Aug 19 '22 21:08 opusforlife2

No, my idea is to link to the NP guidelines in the NPE guidelines, and state the differences in the earlier.

triallax avatar Aug 19 '22 21:08 triallax

Ah. Makes complete sense.

opusforlife2 avatar Aug 19 '22 21:08 opusforlife2

What happened to this?

Do we have a list of differences? Or should we just create the initial version referring to the NewPipe version?

arunkd13 avatar Aug 17 '23 14:08 arunkd13

I think we should hold off on this for now. This can be harmonised with the rewrite, and whatever practices and conventions are used there.

opusforlife2 avatar Aug 18 '23 19:08 opusforlife2