Thank you for your interest in contributing to CourseUp 😄 This document contains information related to contributing to this project and codebase.
Please read through this document prior to participating in this project.
- Follow the steps to set up your development environment.
- Pick an unassigned GitHub issue to work on.
- If you are a first time contributor, the good first issue tag is a useful place to start!
- Have discussions about the issue within the comment section of that issue!
- Create a new branch using
git checkout -b <branch-name>.- Tip: Make sure you're up to date with
main. - Tip: Try to use a descriptive branch name.
- Tip: Make sure you're up to date with
- Commit the changes you've made and push to GitHub to create a Pull Request using the templates provided.
- Make sure you are clear with the changes and note anything that would be useful for the reviewer to know.
- Your PR doesn't have to be perfect right from the start so don't sweat. Coding is an iterative process with plenty of back and forth.
- Communicate with maintainers and the community in CourseUp's discussion!
Experience with React, TypeScript, and other technologies the website is built on is useful but not required! Contributing to the project can help you build skills and gain experience writing in a company-like codebase. Picking issues with the good first issue tag and communicating in the various locations can go a long way.
Click here to create a new GitHub issue. When creating an issue, there is a template provided for you to follow when you create a new issue which you are encouraged to follow. Doing so will make the developers life a lot easier and significantly increase the chances of the issue being addressed.