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

Contribution: Add a guide that explains how to setup this project for developing #6220

Closed
3 tasks done
litetex opened this issue May 2, 2021 · 4 comments · Fixed by #6482
Closed
3 tasks done

Contribution: Add a guide that explains how to setup this project for developing #6220

litetex opened this issue May 2, 2021 · 4 comments · Fixed by #6482
Labels
meta Related to the project but not strictly to code

Comments

@litetex
Copy link
Member

litetex commented May 2, 2021

Preamble: I'm not sure if this is a bug or feature request, it's more like a "meta"-issue.

Checklist

Describe the feature you want

When someone wants to contribute to this project, it would be nice if he knows what he needs to do that (e.g. Android Studio, Android SDK, Java)...
A little setup guide (e.g. first install X then Y, if you install Y make sure you use option Z, ...) could also be good idea.
It would be nice to know the requirements for contributing (where to download them, what version, etc.) and how to set them up.

Currently I was not able to find anything related to this topic.
I checked:

but none of them mentions this topic.

Is your feature request related to a problem? Please describe it

Newcomers have a hard time figuring out what to do if they want to contribute to the project.
This can be depressing and even lead to the point, where they are not even more in the mood for contributing and abandon that try.

Possible solution(s)

Add a "developing.md" somewhere, where the above is explained.

Other projects that explain how to build/develop:

@litetex litetex added the feature request Issue is related to a feature in the app label May 2, 2021
@AudricV AudricV added the meta Related to the project but not strictly to code label May 2, 2021
@XiangRongLin XiangRongLin removed the feature request Issue is related to a feature in the app label May 2, 2021
@ChunkyProgrammer
Copy link

ChunkyProgrammer commented May 2, 2021

There's this https://teamnewpipe.github.io/documentation/00_Prepare_everything/#setting-up-your-dev-environment too (gives set up for environment when working with extractor)

@litetex
Copy link
Member Author

litetex commented Jun 5, 2021

A guide how the checkstyle plugin has to be installed/configured/used would be nice 😄

@Stypox Stypox mentioned this issue Jun 13, 2021
5 tasks
@Stypox
Copy link
Member

Stypox commented Jun 13, 2021

@litetex check out #6482

@litetex
Copy link
Member Author

litetex commented Jun 13, 2021

@Stypox
I did a quick review and it looks already pretty good.
If I have enough time I will do a detailed review in the next days.

Good work! 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Related to the project but not strictly to code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants