Hi there! To help you as a first time contributor, this page has important information about how to setup everything and make your very first Pull Request to the repository. Follow along this page to find things you need to know.
Guide to Obsidian
Our wiki is developed on Obsidian, a powerful knowledge base application that enables connections between concepts. As a contributor, you are encouraged to use Obsidian for creating and editing contents. You can download Obsidian for your preferred platform from the official website Download Obsidian Once you have the software on your device, you will learn how to use Obsidian markdown and other editing techniques from the Obsidian Offical Documentation. If you don’t have time to go through every detail, it is important you understand some formatting skills.
Setup your local vault
Before the setup, we assume you have grasped the Git workflow. If you having issues work with Git, you can refer to our Git Chapter or other online Git tutorials.
- Fork the repository To contribute your bit, you will fork the vault from our wiki’s GitHub repository and clone the fork to your local device.
- Open the vault in Obsidian To access the vault in Obsidian, open the Obsidian application, choose the “Open folder as vault” option. Next, you will locate the Computing_Notes_Obsidian vault you just downloaded on your device.
- Start editing While you can make minor changes such as typo corrections or small edits directly through the GitHub web page, it is important to work within Obsidian to allow the help of live preview and text formatting autocompletion features to keep your content consistent and error free.
Submit your contribution
Make sure to follow theses steps to submit your contribution.
Any force push or deletion will be ruled out by the repository contribution ruleset.
- Commit and push your changes Once you finish your editing, commit and push your changes to your forked repository.
- Open a new Pull Request (PR) When you have completed a full implementation or made a progress, create a Pull Request on GitHub, write a brief line regarding the updates in the PR.
- Review changes Carefully review your changes, check for anomalies, code has to be fully tested and proved it works correctly, and make sure your updates align with guidelines in our Contributor Manual.
- Create PR and await approval Click the “Create pull request” option and your contribution will soon be reviewed by a repository maintainer.
Back to parent page: Contributor Manual