Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Create an issue at https://openwsn.atlassian.net. Let's call it "FW-123"develop
    • Assign it to yourself
      Image Added 
    • Click the "start progress" button
    Branch/fork the develop branch. By convention, call that branch 

    • Image Added 
    • Your issue is now marked "in progress". This ensures people know you're working on a fix.
      Image Added 
  • Fork the repository you want to modify under your username
    • Navigate to the the repository you want to modify, on GitHub. Click the "fork" button
      Image Added 
    • This will create an exact copy of the entire repository, but under your name. That is, "https://github.com/openwsn-berkeley/openwsn-fw" is forked to  "https://github.com/myusername/openwsn-fw". 
    • Optionally, rename your fork openwsn-fw_FW-123.
  • Implement a fix for the issue
    • Commit and /push all your changes into that branchto your fork.
    • Start your every commit message by the issues key, followed by a "." , for example:
      FW-123. Fixed the packet format of RPL DIO.
      This will ensure that your commit activity appears in the "CommitsDevelopment" tab section of your issue.
      Image Added
    • From time to time, merge the develop branch the main repository into your private develop_FW-123 branchfork.
  • When you're done
    • Merge develop into develop_FW-123 Merge the main repository into your fork one last time,
    • From the GitHub interface, create a pull request by clicking the "create pull request" button
    • In the issue tracker, click the "Resolve Issue".
      Image Added Mark the
    • Your issue will now appear as "Fixed".
    The pull request allows everybody to see the proposed changes and discuss
    • resolved"
      Image Added 
    • This tells everybody you consider being done. Normally, you have nothing else to do.
  • The integration managers now merge your fork into the main code
    • If people have comments on your fix, you can discuss directly through GitHub. This can be done line-by-line, making discussion and commenting extremely efficient.
      Image Added 
    • If you want to make further changes, no need to close the pull request, just continue making changes to your branch, your pull request will reflect those further changes automatically.
    • Once the discussion is over and you have done final adjustments to your code, the integration manager merges your pull request is accepted and your develop_FW-123 branch is merged into the develop branch.
    • After the fix is tested, the integration manager marks the issue as "Closed".
    • You can then into the main repository. On GitHub, your pull request now appears as "merged"
      Image Added
    • The integration manager marks your issue as "closed".
      Image Added 
    • You can now delete your fork.