MagicMirror Forum
    • Recent
    • Tags
    • Unsolved
    • Solved
    • MagicMirror² Repository
    • Documentation
    • 3rd-Party-Modules
    • Donate
    • Discord
    • Register
    • Login
    A New Chapter for MagicMirror: The Community Takes the Lead
    Read the statement by Michael Teeuw here.

    How to setup repository for collaboration?

    Scheduled Pinned Locked Moved General Discussion
    2 Posts 2 Posters 1.1k Views 2 Watching
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • M Offline
      mbeiswenger
      last edited by

      So some friends and I all decided to work on a Magic Mirror together. We forked the Magic Mirror repository and are all working on it together. This means that we would all like to be able to develop it on our own personal computers and push to our forked repository, updating the config file as well as adding 3rd party modules. What would be the best way to setup the repository? Should we even fork the repository in the first place to allow for later updates? What .gitignore files should we edit? Thanks in advance.

      Note: I’m still fairly new to Github.

      N 1 Reply Last reply Reply Quote 0
      • N Offline
        ninjabreadman @mbeiswenger
        last edited by ninjabreadman

        @mbeiswenger Suggest you take the free TryGit course. You can also consult the Git documentation and ask questions here (search first!).

        In terms of collaborating, it depends if you will all be working on the same or different features. You will want at least one fork. Also, make your commits small and related (not “here is MM3.0” but “added optional config param capitalizeAll to newsfeed“). You can either share contributor access to a single branch, or all have them fork-your-fork and submit Pull Requests to your fork/branch. You shouldn’t need to modify .gitignore – it should already ignore the right files plus a lot of OS-specific cruft.

        If you ever intend on submitting your changes to the MM develop (not master) branch, see the contributing notes in Contributing.md.

        Problem with config or JavaScript? Copy/paste it into JSHint.
        Check out the detailed walkthroughs on install, config, modules, etc.

        1 Reply Last reply Reply Quote 0
        • 1 / 1
        • First post
          Last post
        Enjoying MagicMirror? Please consider a donation!
        MagicMirror created by Michael Teeuw.
        Forum managed by Sam, technical setup by Karsten.
        This forum is using NodeBB as its core | Contributors
        Contact | Privacy Policy