Versions Compared

Key

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

This document provides details on ACME development conventions and practices.

...

important -- Items colored in red mean they are important, and should not be ignored.

one time -- Items colored in green are commands to be issued once per machine.

repo once -- Items colored in orange are commands to be issued once per local repository.

...

PR Title:  Make sure the title is 70 characters or less and explains the feature you are adding.   By default, it will use the title of the most recent commit.  You should change this if its not descriptive enough. DO NOT include github issue #'s in the title. Hyperlinking does not work from the title.

PR Description.  In the "Write" field, provide a very descriptive message. By default, this will have the description of your last commit.  The reviewer will review the description as part of the pull request, because the description will be the commit message used when the merge is finished.   See merge commit in Commit message template

If the PR is fixing a bug and the bug # was not mentioned in the commit message, include it in the description with the word "Fixes".  Example:  Fixes #89  

When complete, click on "Create pull request".

...

Using the "Assignee" menu, add the name of the designated Integrator for your component.  See Integrator Guide for a list.  This will start the code review and the process of moving this feature to master.  Your PR is not finished until it has been merged to master by the Integrator.


This document can be used to help with pull request related issues.

...

Before communicating with remotes, you might want to add or remove remotes. In order to add and remove remotes the git remote command can be used. The two uses are as follows:

git remote add remote-name protocol:address/to/repo # Creates a remote

 

git remote remove remote-name # Removes a remote

  

In order to communicate with remotes, there are three actions. pushpull, and fetch.

...