Add CHANGELOG.md and clean up branching and pull request sections of …

…CONTRIBUTING.md

CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changes
+
+## 5.0.3
+
+### Component Changes
+
+- Upgrade wwdtm from 2.0.2 to 2.0.5
+- Upgrade Flask from 2.0.2 to 2.1.1
+- Upgrade pytz from 2021.3 to 2022.1
+
+## 5.0.2
+
+### Application Changes
+
+- Change "API Docs" links on the site to read "API"
+
+## 5.0.1
+
+### Application Changes
+
+- Update the Site History page to include version 5.0
+- Update the link to the GitHub repository
+
+## 5.0.0
+
+### Component Changes
+
+- Replace (lib)wwdtm 1.2.x with wwdtm 2.0.2
+- Upgrade Flask from 2.0.1 to 2.0.2
+- Upgrade Materialize CSS from 1.0.0 to 1.1.0-alpha
+
+### Application Changes
+
+- Complete restructuring of the Flask application to use Blueprints design
+  pattern
+- Convert the application from using uWSGI to serve the application to
+  Gunicorn to match the changes made with the Wait Wait Stats API
+
+### Development Changes
+
+- Adding tests by way of `pytest`

CONTRIBUTING.md

@@ -10,33 +10,31 @@ version 2.1 of the Contributor Covenant.
 
 ## Branching
 
-Although the default branch for this repository is `main`, all active
-development needs to be branched off of the `develop` branch.
+The default branch for this repository and the branch used to deploy the
+application into production is `main`. Any bugs that are found in production
+should be made by creating a branch off of the latest version of `main` with
+a descriptive name.
 
-Once you have cloned this repository, you can create a new  branch off of
-`develop` by using the following command:
-
-    git checkout develop; git branch new-branch
-
-Once development has been completed for the new feature or fix and local
-testing has been completed, it can be pushed using the following command:
-
-    git push -u origin new-branch
+All new feature development is handled off of the `develop` branch, which in
+turn would be merged into `main` after thorough unit and regression testing
+in a development and/or staging environment.
 
 ## Pull Requests
 
 Once the new branch has been published to Github, the next step will be to
-create a new pull request to merge the new branch with the `develop` branch.
+create a new pull request to merge the new branch with the `main` branch for
+production bugfixes or the `develop` branch for new features.
 
 After creating the pull request, it will go through a review and the request
 will either be accepted or declined based on needs, code quality, testing
 problems or any other reason that will be included in the commit message or
 request declined message.
 
-Pull requests from new branches to the `main` branch that do not go through
-the `develop` branch via a pull request will be declined.
+Pull requests for new feature branches to merge directly with the `main`
+branch and have not gone through the `develop` branch pull request process
+(as well as the required testing) will be declined.
 
 ## License
 
 This project is licensed under version 2.0 of the Apache License. A copy of
-the license is available in this repository at [LICENSE](LICENSE).
+the license is available in this repository at [LICENSE](LICENSE).

README.md

@@ -13,16 +13,23 @@ weekly quiz show [Wait Wait... Don't Tell Me!](http://waitwait.npr.org)
 
 ## Installation
 
-Refer to [INSTALLING.md](INSTALLING.md) for information on how to set up an
+Refer to [INSTALLING.md](./INSTALLING.md) for information on how to set up an
 instance of this web application that can be served through NGINX and Gunicorn.
 
+## Changes
+
+For changelogs, refer to [CHANGELOG.md](./CHANGELOG.md).
+
 ## Contributing
 
 If you would like contribute to this project, please make sure to review both
-the [Code of Conduct](CODE_OF_CONDUCT.md) and the
-[Contributing](CONTRIBUTING.md) documents in this repository.
+the [Code of Conduct](./CODE_OF_CONDUCT.md) and the
+[Contributing](./CONTRIBUTING.md) documents in this repository.
 
 ## License
 
 This web application is licensed under the terms of the
-[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+[Apache License 2.0](./LICENSE).
+
+Original version of the Apache License 2.0 can also be found at:
+<http://www.apache.org/licenses/LICENSE-2.0>.