Skip to content

Commit

Permalink
Applying autoformatter across projects for consistency.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdlaird committed May 4, 2024
1 parent d0b5890 commit 688bb38
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 3 deletions.
4 changes: 4 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
### Description

A clear and concise description of what was changed.

Fixes # (issue number)

### Type of Change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a schema change
- [ ] This change requires a documentation update

### Testing Done

A clear and concise description of the new tests added to validate the change as well as any manual testing done.

### Checklist

- [ ] I have added tests that prove my change works as expected, and `make test` passes with no new errors or warnings
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code in particularly hard-to-understand areas
1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,5 @@ For answers to common questions about this code of conduct, see
<https://www.contributor-covenant.org/faq>.

[homepage]: https://www.contributor-covenant.org

[mailto]: mailto:[email protected]
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@
# {%PROJECT_NAME%}

## Getting Started

The project is developed using Python and [Django](https://www.djangoproject.com).

This repository contains the source code for the {%PROJECT_NAME%} project.

### Project Setup

To setup the Python/Django build environment, execute:

```sh
Expand All @@ -28,13 +30,15 @@ source .venv/bin/activate
All commands below will now be run within the virtualenv (though `make` commands will always automatically enter the
virtualenv before executing).

To ensure the database is in sync with the latest schema, database migrations are generated and run with Django. To run migrations, execute:
To ensure the database is in sync with the latest schema, database migrations are generated and run with Django. To run
migrations, execute:

```sh
make migrate
```

Once migrations have been run, you can create a super user, which is a standard user that also has access to the /admin site.
Once migrations have been run, you can create a super user, which is a standard user that also has access to the /admin
site.

```sh
python manage.py createsuperuser
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Supported Versions

| Version | Supported |
|---------| ------------------ |
|---------|--------------------|
| 1.3.x | :white_check_mark: |
| < 3.2 | :x: |

Expand Down

0 comments on commit 688bb38

Please sign in to comment.