Using GitHub - ktopolov/DatabaseSystem GitHub Wiki

GitHub can be used effectively by taking advantage of the organizational tools needed for project management and maintenance.

Issues

When something needs to be added to a repository (a feature, bug fix, etc.), good practice is to create an issue. The issue should specifify what is needed to be done and the Acceptance Criteria (AC) required to close the issue.

To create an issue, go to Issues>>New Issue and give a title and description of the issue. Explicitly list **AC: ** for the acceptance criteria and list what must exist to close and merge the issue. Assign an Assignee, add label(s) to classify the type of issue, and optionally attach the project and/or milestone to which this issue is attached.

Creating Branches

To create a branch:

  • Navigate to the home page of the repository
  • Use the dropdown to select the desired base branch
  • Click the dropdown again and type the name of the new branch to be created.
  • Click on Create branch: <new_branch> from <base_branch>

Pull Requests

⚠️ **GitHub.com Fallback** ⚠️