Skip to content

Commit

Permalink
created pull request template to close #113
Browse files Browse the repository at this point in the history
**Related Issue**

closes #113

**Database Changes/Migrations**

N/A

**Added/Altered API Routes***

N/A

**Test Modifications**
N/A

**Test Procedure**

1. Create a branch
2. Commit a change to that branch
3. Push branch
4. Create Pull Request and fill in PR template
  • Loading branch information
jshom authored Apr 21, 2020
1 parent 67406b9 commit fa4386c
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
**Related Issue**

Note which issue number this issue closes.

*Example:*
> closes #113
**Database Changes/Migrations**

If you added/modified a table, notify people of schema change here.

*Example:*
> Added table `account_semester_selection` for a mapping from a students account and semester to a class and section (aka class/section selections)
**Added/Altered API Routes***

List added/altered API Routes, example:

*Example:*
> Added: `GET /api/class/FALL-2020` - Fetch all classes from semester (Fall-2020)
>
> Modified: `GET /api/class/FALL-2020?meet-prerequisites=true` - Added filtering on prerequistite through query string
**Test Modifications**

Note added unit/integration tests: (all backend changes should contain unit/integration tests with pytest).

*Example:*
> Added test `tests/api/db/test_classinfo.py:test_crn_uniqueness` to ensure all classes returned from API call don't have repeat CRNs
**Test Procedure**

Show procedure to test functionality with a clear procedure

*Example:*
> 1. Create a branch
> 2. Commit a change to that branch
> 3. Push branch
> 4. Create Pull Request and fill in PR template

0 comments on commit fa4386c

Please sign in to comment.