Thank you for your interest in contributing to the Tech Start UCalgary website repository! We welcome any and all contributions to improve our website and make it a better resource for our community. Before making a contribution, please read and follow these guidelines to ensure that your changes are appropriate and contribute to our goals.
| Name | GitHub Profile |
|---|---|
| Joel Happ | Jhappy77 |
| Niyousha Raeesinejad | Niyousha99 |
| Ben Schmidt | Anidion |
| Wai Ka Wong | Wongsitu |
| Abod Abbas | Abodthedude25 |
| Name | GitHub Profile |
|---|---|
| Sahiti Akella | Sahitiakella |
| Isaiah Asaolu | Isaiah |
| Brian Nguyen | brian-ngyn |
There are several types of contributions that you can make to this repository:
- Bug fixes: If you notice a bug or issue with the website, submit an issue and fix that addresses the problem.
- Content updates: If you notice outdated or incorrect information on the website, please submit an update with the correct information. Please refer to our Content Updates Guide for details on how and when to update different types of content.
- Design improvements: If you have design suggestions or improvements to make the website more user-friendly or visually appealing, please submit your ideas and any relevant code changes.
- New features: If you have an idea for a new feature or functionality that would be useful to our community, please submit your proposal and any relevant code changes.
To get started contributing to the Tech Start UCalgary website, please follow these steps:
- Clone the repository to your local machine.
- Make sure you're on our
mainbranch:git checkout main. - Pull our latest changes so that you are up-to-date with the branch:
git pull origin main. - Create a
.env.localin the root of the project. Add the followingREACT_APP_PIC_API_URL=https://tsu-server.vercel.app/apiOr to connect to the local serverREACT_APP_PIC_API_URL=http://localhost:3001/api/ - Create and switch to your own branch (which should be a descriptive name of your feature change):
git checkout -b your-name/name-of-feature-change. - Make your code changes.
- Add all your changed files:
git add --all. Alternatively, you can add selected files as well. - Sign off and commit your changes along with a short and informative description of changes :
git commit -s. - Push your changes to your remote branch:
git push origin name-of-feature-change. - Create new pull request on GitHub. Make sure to set your target branch to
dev, assign yourself as the assignee, and include a brief description of your changes. - Once your PR has been created, go to your issue, click on "Linked pull requests", and select your PR to link to your issue. You can refer to this past PR as an example.
- Add all relevant reviewers to your PR; at minimum this should include the Presidents, VP Communications, VP Development, any relevant active contributors. You will be able to merge your PR once you receive at least 2 approvals from your reviewers.
- Vercel will automatically host your branch, so everyone can test it. Please ensure you do thorough testing to catch any bugs.
- An admin will review and deploy your changes to the website by pushing your changes from your branch to the
mainbranch. - After you have merged your PR to
main, please delete your remote branch.
In the project directory, you can run:
Runs the app in the development mode. Remember to run npm install first to install all dependencies needed to run the app in development.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits. You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc.) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
When making code contributions to the Tech Start UCalgary website, please follow these guidelines:
- Write clear, concise code that is easy to understand and maintain.
- Use descriptive variable and function names.
- Test your code thoroughly before submitting it.
- Follow existing coding standards and conventions.
- Avoid making changes that are not related to your contribution.
If you are making non-code contributions to the Tech Start UCalgary website, such as design or content updates, please follow these guidelines:
- Provide clear and detailed descriptions of your changes.
- Include any relevant images or files.
- Follow existing design and content standards and conventions.
- Avoid making changes that are not related to your contribution.
Please note that all contributors are expected to adhere to the Tech Start UCalgary Code of Conduct
If you have any questions or concerns about contributing to the Tech Start UCalgary website repository, please contact us at [email protected].
Thank you for your contributions to our community! 👐