Thank you for considering contributing to The Learning Hub. These guidelines apply to every guide in the TheLearningHubOrg organization unless a repository has its own CONTRIBUTING file.
By contributing, you agree to abide by the Code of Conduct.
- Fix an error: a wrong explanation, broken code sample, outdated API, dead link or typo. Open a guide error issue first if the fix is not obvious.
- Improve a section: add examples, diagrams or interview questions to a stage that is thin.
- Propose a new guide: open a new guide request issue so it can be discussed before any work starts.
- Review open pull requests and confirm that code samples run.
- Fork the repository.
- Clone your fork.
- Create a new branch with a descriptive name, such as
fix/stage-3-typo. - Make your changes.
- Push your branch to your fork.
- Open a pull request against
mainand fill in the template.
Keep each pull request focused on one change. Small pull requests are reviewed faster.
Most guides follow the same layout. Please keep it intact when you edit one:
- A 7-stage roadmap, from fundamentals to an interview handbook in Stage 7.
- A table of contents that matches the headings in the README.
- Code samples that run as written on the version stated in the README.
- Mermaid for diagrams, so they render on GitHub without image files.
- Plain, direct writing. Explain why something works, not only how.
If the guide includes an app or project folder, run its tests and build before you open a pull request.
Do not open a public issue for a security problem. See the Security Policy.
Contributions are made under the license of the repository you are contributing to. Check that repository's LICENSE file for details.