One of the major goals of The Coding Train is to provide a beginner-friendly environment for people to make pull requests and contribute to projects. This guide discusses how to contribute to The Coding Train website. We encourage you to make contributions to this repository, and mistakes and confusions are always welcome. We are here to help!
The Coding Train strives to be a respectful, friendly, and welcoming community. Read our Code of Conduct to learn about what is and is not acceptable.
Get an overview of the project in README. If you are new to open source contributions, here are some useful guides that can help you get started:
- Git and GitHub for Poets: A Coding Train video series for Git and GitHub beginners.
- Collaborating With Pull Requests: A GitHub guide on pull requests.
Here are the types of contributions we are looking for this month:
-
Share your creative work inspired by a coding challenge or tutorial in the showcase!
- You can find more information about submitting a showcase in the Passenger Showcase Guide
-
Create a page for a Coding Challenge video! (CodingTrain#155)
- Head to the spreadsheet tracking challenges and sign up.
- For instructions, read the Maintaining the website guide on how to create a challenge page on the new website.
- Note: If you are unable to complete the page, please add a note and remove your name from the spreadsheet.
-
Add Related Challenges! (CodingTrain#262)
- The
"relatedChallenges"property specifies a list of challenges to be featured as suggested on the video page. - If it is an empty array and there are any coding challenges in the
"video"section of the json file, those challenge(s) can be added to the field. - You can find the JSON files for challenges in
/content/videos/challenges.
- The
-
More!
- You can find more things to work on listed in issues.
Here is a guide to the content structure of the website to help you through the process of contributing.
If you are about to create a new issue, search if an issue already exists regarding the same problem. If a related issue doesn't exist, go ahead and open an issue describing the problem. An issue could be about a bug that you discovered, a suggested change or even a discussion.
To find an issue that you want to fix, scan through the list. You may find that the labels are helpful in this situation. You can use them as a filter as well while searching.
- To make changes to this repository, make sure to fork it and make changes to your fork locally, without harming the original project.
- It is good practice to create a different branch for different changes.
- Commit the changes you are making at every step, and make sure to add good commit messages describing the part you added/changed with that specific commit.
- When you are happy with your changes and are ready to publish them, make a pull request. We will review your suggested changes and hopefully merge them!
Make sure you have Node.js version 18.x as well as npm installed. You can find how to test your changes locally here.