Welcome to the ITAS GitHub Organization! This organization is dedicated to students and faculty members of the ITAS (Information Technology and Applied Sciences) program. This repository will be the central hub for creating, collaborating, and managing student assignments and group projects.
- Purpose
- Organization Structure
- Repositories
- Getting Started
- Contribution Guidelines
- Code of Conduct
- Support
The primary purpose of this GitHub organization is to:
- Facilitate Collaboration: Encourage students to engage in group projects and work collaboratively.
- Version Control: Utilize GitHub for managing version control of projects and assignments.
- Skill Development: Help students develop practical skills in using version control systems and collaborative coding.
- Feedback & Evaluation: Allow instructors to provide feedback and assess student assignments directly on GitHub.
The ITAS GitHub Organization contains multiple repositories classified generally into two main categories:
- Student Assignments: Repositories related to individual or smaller project assignments.
- Group Projects: Repositories dedicated to group work, including larger capstone projects.
These repositories are usually named following the pattern assignment-coursecode-assignmentnumber, for example, assignment-CS101-01.
Group project repositories often adhere to a naming convention like project-groupname-coursename, such as project-teamalpha-SD102.
- Create a GitHub Account: Make sure you have a GitHub account and are added to the ITAS organization.
- Clone Repository: Clone the relevant repository to your local machine using:
git clone https://github.com/ITAS-org/repository-name.git
- Commit Changes: Work on your assignments/projects, and commit changes regularly.
git add . git commit -m "describe your changes" git push origin branch-name
- Create Repository: Set up repositories for assignments or projects and assign access permissions.
- Review Work: Monitor contributions and provide feedback or grades using GitHub's review tools.
- Main Branch (Master): Reserved for final and stable code.
- Development Branch: Used for developing new features and major changes.
- Feature/Assignment Branches: Work should be done on branches named after the feature or assignment, e.g.,
feature-login,assignment-01.
- Ensure the code compiles and runs correctly.
- Make sure to write clear commit messages.
- Open a pull request against the
developmentbranch. - Await review and approval from instructors or team leads.
- Use clear and descriptive commit messages.
- Include the purpose and what changes have been made.
All participants are expected to adhere to our Code of Conduct, which establishes guidelines for respectful and productive collaboration.
If you have any issues or need assistance, please reach out to:
- Faculty Advisors: contact your respective course instructor.
- Technical Issues: Open an issue in the relevant repository or email support at
itsupport@university.edu.
Thank you for being a part of the ITAS program and contributing to our collaborative learning environment. Happy coding!
This README was last updated on [Date].