Thank you for checking out the Sourcegraph Learn repo, and for considering contributing to this project!
If you need guidance on contributing to open source, please review the tutorial How To Create a Pull Request on GitHub or watch the video Your First Pull Request with Lyn Muldrow.
For additional guidance, review the official Hacktoberfest site.
Hacktoberfest contributions are limited to what is described below. All other pull requests will be marked as invalid.
Select one of the issues labeled as good first issue.
Each of these issues are troubeshooting technical tutorials for educational purposes. You can find other Sourcegraph issues, including code issues on our Good first issues board.
Once you have selected an issue, clone the project locally and create a branch for your work. You'll be creating a markdown file in the /posts
directory. You can follow our Getting started guidance if you would like to run a local development environment to preview your work, which is recommended.
Follow the example tutorial How to troubleshoot Python ZeroDivisionError and the guidance in the issue on how to structure your tutorial. Test the code and ensure everything is grammatically correct.
If you would like to add your name to the authors.yaml
file, follow the format in /data/authors.yaml
.
When you are satisfied, open your pull request referencing the issue that you are resolving. Please note that maintainers will make the ultimate decision of whether or not pull requests are merged into the project.
Thank you for considering contributing to Sourcegraph Learn!