Thank you so much for your interest in contributing to Community Taught! I am so glad you are here. If you'd like to make a contribution to the project, please follow the steps below.
If you are looking for an issue to work on, please look through the issues tab and find one that you are interested in. Add a note asking to work on the issue. If you'd like to make a change that isn't related to a current issue, please create one. Explain the change you'd like to make and why.
Once you've found an issue you'd like to work on, please wait for it to be assigned to you. This is to prevent multiple people from working on the same issue, and to make sure that everyone is on the same page.
Once you've been assigned an issue, please fork the repository.
Once you've been assigned an issue, please create a branch with the issue number and a short description of what you are working on. For example, if you are working on updating the lesson card styling and the issue is #1, you would create a branch called issue-1-lesson-card-styling
. If you are working on multiple issues, please be careful to create each branch off main. Do not branch off of an issue branch.
Make the necessary changes on your new branch. If you come across additional changes that need to be made, unrelated to the issue you're working on, please do not make those changes on this branch. Instead, create a new issue.
Once you've made the necessary changes, create a pull request. In the pull request, please explain what you've changed and why. Especially note any divergences from the original issue, problems you encountered, or anything else that you think is important to note.
Please be sure to link the pull request to its issue.
After you submit your pull request, it will be reviewed. It will either be accepted or changes will be requested. If requested, please make the necessary changes and resubmit your pull request.
Congratulations! You've made your first contribution to Community Taught!