Feedback

CODE_OF_CONDUCT.md

@@ -0,0 +1,107 @@
+# Code of Conduct
+
+## v1 - Drafted by Izaac Saleh & Sukhwan Ko
+
+## Our Pledge
+
+---
+
+As Members of this developer community, as both leaders and contributors, we pledge to
+respect all people who contribute through reporting issues, posting feature requests,updating documentation,
+submitting pull requests, and other activities.
+
+We aim to make participation a harassment free experience. Discrimination towards, but not limited to: age, body size,
+visible or invisible disability, ethnicity, gender identity and expression, level of
+experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and
+orientation will not be tolerated.
+
+We will act and interact only in ways that promote welcoming, diverse, inclusive and healthy community interactions.
+
+## Our Standards
+
+---
+
+Examples of unacceptable behaviour by participants include but are not limited to:
+
+- Derogatory comments towards others contributions
+- Personal attacks
+- Public or private harassment
+- Publishing others private information such as electronic or physical addresses.
+- Any other conduct that could be reasonably considered inappropriate in a professional setting.
+- Discrimination with regard to _any_ of the criteria mentioned in our **Pledge**
+
+Examples of positive behaviour that contributes to the community:
+
+- Willingness to help others and answer questions
+- Respecting differing opinions and viewpoints that are born of varying experiences.
+- The handling of constructive feedback in a graceful manner be it giving or receiving.
+- Accepting responsibility and accountability for our mistakes, especially when they affect others work and learning
+- from the experience.
+- A focus on the betterment of the community over the individual needs.
+
+## Maintainer Responsibilities
+
+---
+
+Our Community Leaders are responsible for clarifying and enforcing the standards of
+acceptable behviour and are expected to lead by example. If a breach of the Code of Conduct is found to have occured the
+Community Leaders are charged with taking appropriate but fair corrective action.
+
+Community Leaders have the responsibility, and maintain the right, to remove, edit, or reject comments, commits, code,
+issues, and other contributions that are not in alignment with this Code of Conduct and will communicate the reasons for
+any moderations they deem appropriate.
+
+## Scope
+
+---
+
+- Our online platform (website, forum, chatroom etc.)
+- Code repository (including comments, pull requests, issue reports etc.)
+- Project-related communication channels such as:
+  - Email
+  - Slack
+  - Microsoft Teams
+  - Discord
+  - Asana
+  - etc.
+- In-person events(Conferences, meetups etc.)
+
+## Enforcement
+
+---
+
+Community leaders will take action to address violations of the Code of Conduct. The specific consequences will depend on the severity of the violation.
+
+## Enforcement Guidelines
+
+---
+
+1. Correction
+
+- **Community Impact:** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+- **Consequence:** A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+2. Warning
+
+- **Community Impact:** A violation through a single incident or series of actions.
+
+- **Consequence:** A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+3. Temporary Ban
+
+- **Community Impact:** A serious violation of community standards, including sustained inappropriate behavior.
+
+- **Consequence:** A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+4. Permanent Ban
+
+- **Community Impact:** Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+- **Consequence:** A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the GITHUB documents template for "code of conduct" found when adding a file of the
+name to your repo. For steps on accessing this template please see the link below.
+https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project

CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# CONTRIBUTING
+
+## v1 - Drafted by Tadiwanashe Gukwa & Lucas Fadersen
+
+Participation in the agile development of this project, including modification, testing, and editing, is only accessible to NM-TAFE students who have received a link to this repository via their outlook email.
+
+## ENFORCEMENT GUIDELINES
+
+---
+
+The is Zero tolerance to plagiarism, make sure that the code you contribute is your own work.
+N.B While working on this project the NM-TAFE code of conduct still applies.
+
+## CONTRIBUTION
+
+---
+
+### Project set up
+
+1. Fork the repo to your local device
+2. Follow the steps on this link to set up the project \***\*link\*\***
+
+## ISSUES
+
+---
+
+1. Identify a Bug: When you Identify a bug during the debugging process, and you intend to fix it you create an issue on GitHub.
+2. Add a description and comment: Make sure that the description of the issue is clear with the issue number and add a comment describing the issue. The issue is reserved for the maker unless open-to-all tag is added.
+3. Add a tag/label to the issue for example bug, enhancement, help wanted, priority: high, priority: low
+4. Add the ready-for-work tag to an open issue when prepared to start working on it. This lets other programmers know that someone is working on the issue in their local IDE. By doing so, collisions are avoided.
+5. Create a Branch: Before you start fixing the issue in your local IDE open your terminal, create a new branch using this command git check out -b <issue number>.
+6. Fix the issue - create a test. When your test passes push the changes
+7. Create a pull request: Create a pull request and associate it with the issue number on the pull request description for example if the issue is issue # 1 the pull request description will include Fixes #1 in the description so that when you merge changes the issue closes automatically.
+8. Code Review - The project maintainers will review the code. Once approved changes will be merged into the main branch
+9. Closing Issue - The issue is closed automatically by GitHub if step 3 was followed correctly
+
+## CODE ENHANCEMENT
+
+---
+
+New ideas can be suggested and discussed on our the Team Discussion Board or Teams Chats first before implementing changes. **_channel link_**
+
+## LICENCE
+
+---
+
+This project is licensed under the [Creative Commons Zero v1.0 Universal](LICENSE) license.
+
+## CODING STYLE
+
+---
+
+Before contributing check this link for the style guide for this project which includes Code lay-out, Comments, Docstrings and naming conversions
+
+- Project STYLE_GUIDE.md (\***\*link\*\***)
+- PEP 8 – Style Guide for Python Code | peps.python.org

README.md

@@ -1,7 +1,15 @@
+[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-24ddc0f5d75046c5622901739e7c5dd533143b0c8e959d652212380cedb1ea36.svg)](https://classroom.github.com/a/SCA-edx6)
+
 <div align="center">
 
 # OcrRoo
 
+## v1 - Drafted by Rafael Avigad/James Makela
+
+---
+
+[Badges here]
+
 **AI Powered OCR Code Recognition from Video Tutorials**
 
 [![Build](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/build.yml/badge.svg)](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/build.yml)
@@ -15,19 +23,66 @@
 A video player designed to assist visually impaired developers who want to learn to code.
 The program reads code from videos to assist visually impaired developers in using these resources.
 
+## Features - (need more info)
+
+---
+
+[Demo Video here]
+
+- Ability to upload, or enter a video link.
+- OcrRoo picks out any code text from the provided video, and reads that text to the user.
+
 ## Installation
 
 To install and run this project, please follow the [Installation Guide](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/wiki/Installation-Guide)
 in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/wiki).
 
+#### Basic Installation
+
+1. Navigate to the projects root folder
+
+2. Create a virtual environment
+
+```bash
+python -m venv ./venv
+```
+
+3. Activate the virtual environment
+   Windows:
+
+```bash
+./venv/Scripts/activate
+```
+
+Mac/Linux
+
+```bash
+source venv/bin/activate
+```
+
+4. Install dependencies with pip
+
+```bash
+pip install -r requirements.txt
+```
+
+5. ...rest of installation steps here
+
 ## Contributing
 
 To contribute to this project, please follow the [Contribution Guide](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/wiki/Contribution-Guide)
 in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/wiki).
 
+## Code of Conduct
+
+---
+
+- To view the code of conduct, please visit the [Code of Conduct] page in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/wiki).
+
 ## License
 
 This project is licensed under the [Creative Commons Zero v1.0 Universal](LICENSE) license.
 
 ## Credits
-This code was first created by the 2023, S2 Advanced Programming Diploma Group at North Metro TAFE. If you would like your contribution acknowledged, please contact Rafael. 
+
+This code was first created by the 2023, S2 Advanced Programming Diploma Group at North Metro TAFE. If you would like your contribution acknowledged, please contact Rafael.

STYLE_GUIDE.md

@@ -0,0 +1,55 @@
+# Style Guide Draft
+
+## v1 - Drafted by Cooper Whitehurst & Blony Maunela
+
+## Adherence to PEP 8:
+
+- Ensure Python code meets PEP 8 requirements.
+
+## Consistency:
+
+- Ensure consistent indentation, line length, and naming conventions.
+
+## Variable and Function Naming:
+
+- Use snake_case for variables and functions, and CamelCase for classes.
+
+## Automated Code Formatting:
+
+- Use tools like Black to ensure uniform code formatting.
+
+## Imports Organisation:
+
+- Organise imports into standard library, third-party, and project-specific categories.
+
+## Docstrings:
+
+- Provide explicit docstrings for function purpose, parameters, and return values.
+
+## Comments:
+
+- Keep comments concise and relevant for better code readability.
+
+## Error Handling:
+
+- Consistently handle errors with exceptions and documentation.
+
+## Code File Structure:
+
+- Organise code files with logical imports, class/function definitions, and major blocks.
+
+## Test Organization:
+
+- Organise tests with clear function names.
+
+## Version Control Best Practices:
+
+- Use informative commit messages and appropriate branching methods.
+
+## Code Review standards:
+
+- Establish explicit standards for code review, including style, functionality, and documentation.
+
+## Licence and Copyright:
+
+- Include licencing conditions and copyright notices in your project.