From 782c2f51e46b62c07b5878fb79c43399c44f3ce3 Mon Sep 17 00:00:00 2001 From: "github-classroom[bot]" <66690702+github-classroom[bot]@users.noreply.github.com> Date: Wed, 22 Jan 2025 14:38:45 +0000 Subject: [PATCH] Initial commit --- README.md | 47 +++++++++++++++++++++++++ etc/GUIDELINES.md | 30 ++++++++++++++++ sprints/SPRINT_TEMPLATE.md | 71 ++++++++++++++++++++++++++++++++++++++ src/.gitkeep | 0 4 files changed, 148 insertions(+) create mode 100644 README.md create mode 100644 etc/GUIDELINES.md create mode 100644 sprints/SPRINT_TEMPLATE.md create mode 100644 src/.gitkeep diff --git a/README.md b/README.md new file mode 100644 index 0000000..3fdc7e8 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# << Project Title >> +## CS 445 Final Project +### << Semester, Year >> + +### Team: << team name >> +<< List Team Members >> + +## Getting Started +<> + +### Roadmap + << +A list of features, function or non-functional, you would like to add in the future if you had time, i.e. Phase 2 stuff +- [ ] Add Changelog +- [ ] Add back to top links +- [ ] Add Additional Templates w/ Examples +- [ ] Add "components" document to easily copy & paste sections of the readme + >> + +## SRS +[document](url to google doc) + +### Prerequisites +* [Docker](https://www.docker.com/) +* <> + +### Installing +<< + A step by step series of examples that tell you how to get a development env running +Say what the step will be +`Give the example` +And repeat +`until finished` +End with an example of getting some output from the system, such as a menu or prompt +>> + +## Built With + << list all frameworks and modules used here >> +* [requests](https://docs.python-requests.org/en/latest/user/quickstart/#make-a-request) - request for humans + +## License +<< Add a [license](https://choosealicense.com/) >> + +## Acknowledgments +* Hat tip to anyone whose code was used +* Inspiration +* etc diff --git a/etc/GUIDELINES.md b/etc/GUIDELINES.md new file mode 100644 index 0000000..863f7ba --- /dev/null +++ b/etc/GUIDELINES.md @@ -0,0 +1,30 @@ +# CS445: Software Engineering Guidelines + +*A portion of your team's final project will be graded against these guidelines and specifications* + +1. Software breaks at the interfaces + * If you don't do a system architectural design with well-defined interfaces, integration will be a big mess.You must have some external system architecural design that is kept up to date with your current architecture. + +2. Good software is in your head, not the computer + * Design, Design, Design, then design some more. You should spend at least as much time designing your code, before you write a single line, as you will spend coding. + +3. Try to make your development environment as close to your production environment as possible (without giving away secrets) + * Designing the running environment is as important as designing project itself. Many projects require as much time setting up the running environment as they do for development. + +4. "What takes 1 Dev one month to complete, will will take 2 devs two months, but will be better" + * The more people on a project the longer it takes. Adding team members that are new to a project are less productive (1/3 to 2/3 less), so new devs add at minimum 1/3 more time to the timeline. + +5. Productivity varies greatly depending knowledge of the tools, methods, and notations used + * Invest time in Documentation. Don't write from scratch something that can be easily accomplished with a call to a library. + +6. Fluctuating and conflicting requirements reduces software productivity and quality + * Each time a component or requirements changes, the amount of work to integrate the change is proportional to how much of the project has already been completed. + +7. The earlier problems are discovered, the less the overall cost will be. + * The client meeting to determine how the software will be used is the most imporant meeting in the software development process. No matter how good your software is, if it doesn't meet the client's needs, it is an unsuccessful software product. + +8. Once a requirement is met, it should be considered frozen until project completion. + * If requirements are not locked on completion, the project risks feature creep. **Feature Creep** entails constantly adding new capabilities to existing features, rather than tackling incomplete requirements. + +9. Separate the things that change from the things that stay the same + * This applys when talking about single functions or entire applications. Always ask, what may change here and how do I minize that changes impact. diff --git a/sprints/SPRINT_TEMPLATE.md b/sprints/SPRINT_TEMPLATE.md new file mode 100644 index 0000000..39447eb --- /dev/null +++ b/sprints/SPRINT_TEMPLATE.md @@ -0,0 +1,71 @@ +# Sprint Meeting Notes + +*note: replace anything surrounded by << >> and **remove** the << >>* + +**Attended**: << record the team members in attendance (virtual counts as long as they are participating) >> + +**DATE**: << meeting date >> + +*** + +## Sprint << num >> Review + +### SRS Sections Updated + +<< List any SRS sections that were updated in the last sprint >> + +### User Story + +<< Corresponding User Stories completed in this sprint >> + +### Sprint Requirements Attempted + +<< The corresponding SRS requirement that the team completed in the last sprint >> + +### Completed Requirements + +<< The work that's been completed in this sprint >> + +### Incomplete Requirements + +<< The work that has not been completed in this sprint. Be VERY detailed and specific regarding what isn't working and what needs to be completed >> + +### The summary of the entire project + +<< A general overview of the entire project >> + +*** + +## Sprint << num >> Planning + +## Requirements Flex + +<< # >>/5 requirement flexes remaining + +## Technical Debt + +<< Any requirements from the previous sprint that are using a technical flex >> + +### Requirement Target + +<< The corresponding SRS requirement that our team will be complete in next sprint >> + +### User Stories + +<< Corresponding User Stories >> + +### Planning + +<< Our team's detailed plan to complete the sprint >> + +### Action Items + +<< A list of things that need to happen in our for our team to complete the sprint >> + +### Issues and Risks + +<< A list of potential obstacles that could keep us from completing the sprint and what's being done about them >> + +### Team Work Assignments + +<< A list of each team member and their works assignments for this sprint >> \ No newline at end of file diff --git a/src/.gitkeep b/src/.gitkeep new file mode 100644 index 0000000..e69de29