Skip to content
New issue

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

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

Already on GitHub? # to your account

Code Organisation #12

Open
JakeMercer opened this issue Sep 22, 2018 · 2 comments
Open

Code Organisation #12

JakeMercer opened this issue Sep 22, 2018 · 2 comments

Comments

@JakeMercer
Copy link

Hi James, love the project! I just have a few suggestions on how to organise your code; a few small changes that would make contributing to the repository much easier.

By organising the code into "parts" corresponding to your videos you're not really exercising the real power of Git. Instead of having copies of the main dog INO file with each video's changes in a different directory, you should have a single file that you change and make a commit for each video you produce. This would help clean up the repo and mean if anyone makes a pull request with useful changes to the code, it's easy for you to pull those changes into your file and don't have to manually sync those changes into files you have yet to push.

There is a useful discussion on the topic in this StackOverflow question.

There are a number of common structures that could be defined in a common header file so that if you needed to make extensions, you only have to do that in one place.

Cheers,
Jake

@is4n
Copy link

is4n commented May 23, 2019

It would make sense to create a separate branch along with each new video as a reference and continually update master (or any other branch) as any normal code project would. This would make it easy both for those watching through the videos, since they can "follow along" with the code, and for devs since they can benefit from Git as it's meant to be used.

@mrbesen
Copy link

mrbesen commented Feb 5, 2020

instead of making branches, you can just tag the latest commit of a video with "PartXX" or something.

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

No branches or pull requests

3 participants