Skip to content

Latest commit

 

History

History
63 lines (32 loc) · 4.28 KB

MENTORS_INFO.md

File metadata and controls

63 lines (32 loc) · 4.28 KB
Raw

Getting Started Instructors

This guide will help instructors set up the Web App Template for HighTechU.

Adding Students to the HighTechU GitHub Organization

You will need to invite each HighTechU Student to the HighTechU GitHub Organization. For more information, visit "Inviting users to join your organization".

Note: It is important that HighTechU Students accept the invitation to join the organization to prevent access issues.

Adding Students to the HighTechU Team

You will need to add each HighTechU Student to the appropriate team. Usually this team will reflect the current cohort. (For example, Techccelerator). For more information, visit "Adding organization members to a team".

Creating the Repository

The HighTechU Web App Repository allows for GitHub users to create a new repository using this repository as a template. For more information, visit "About repository templates".

You will need to name the new repository appropriately, for now you can name it following the convention below:

techccelerator-app-team-X

The HighTechU Students will rename the repository later when they have created their Discord Bot Branding.

Note: You will create the new repository as private. The repository will become public after the program is finished.

Repository Permissions

You will want to restrict the main branch. You will need to create a branch protection rule. For more information, visit "Creating a branch protection rule".

You will want to set up "Require pull request reviews before merging", "Required approving reviews: 1", and "Require review from Code Owners".

Note: This is a crucial step! It is very important to limit HighTechU Students ability to push code to the main branch without review. This is to avoid broken code, publishing secrets, adding empty files, conflicts, and inappropriate contributions.

Note: This means that developers cannot push to the main branch and that developers will need to develop on a separate branch and create a Pull Request. The information about Pull Request Workflow can be found in CONTRIBUTING.md.

Repository Access

You will need to add each HighTechU Student to the repository (OR alternatively add the appropriate team). You will initially give them read and write access.

Note: You will be the only person with admin access to the repository. If needed, 1 HighTechU student per team can be granted admin access to configure the Heroku automatic deployment.

For more information about repository access for individuals, visit "Managing an individual's access to an organization repository".

You will need to add the HighTechU Staff Team to the repository. You will give them admin access.

You will need to add the HighTechU Mentors Team to the repository. You will give them read and write access.

For more information about repository access for teams, visit "Managing team access to an organization repository".

Deployment to Heroku

Please follow the steps outlined on the Deployment to Heroku section of GETTING_STARTED.md.

Conclusion

The repository should now be ready for HighTechU Students to start developing and exploring.

Support

The HighTechU Core Staff is able to help with the set up, let us know if you need any help or assistance.

Feel free to update this document with any relevant or additional information.