High Level Requirements

Version Control

Github will be used for version control and code management. Version control is a system that tracks changes to files over time, allowing multiple developers to work on the same codebase without overwriting each other's changes. Github is a popular platform for hosting code repositories and collaborating with other developers.

Commits and forks must be well documented to provide context and explanation for the changes being made. When updates or changes are made to the code, developers should clearly communicate the reasoning behind the changes. If there are conflicts with code changes that cannot be resolved, they should be brought to the team for final review. Overall, changes in code will follow a methodology displayed in Figure 1, which outlines the steps for making and merging changes to the codebase. This helps to ensure consistency and minimize errors when multiple developers are working on the same code.

Figure 1: Methodology for changes in code

The MVP

The Minimum Viable Product (MVP) is the initial version of the website that will be created. The MVP should have proper code conduct, meaning that it adheres to established coding standards and best practices. Specific code requirements should be documented fully so that any programmer can pick up the project where it was left off, even if they are not familiar with the codebase. This includes documenting the code structure, commenting the code, and providing clear instructions for setting up and running the project. By creating a well-documented MVP, the development team can ensure that the project is maintainable and scalable over time.

The MVP for our project would ensure that users have the ability to explore the NAU audio corpus, and play games that help them practice skills like pronunciation.