%% date:: [[2022-09-17]] %% # [[Contributing to an Obsidian plugin]] ### Fork the repository All plugins listed as the [[Obsidian]] Community plugins contain a link to the GitHub repository containing the source code. Fork the repository to your own GitHub account. ### Download the source code Clone your forked repository locally so that you can work on it. ### Make your changes Modify or add to the code. ### Test your code To test it out, install dependencies: `npm i` or `yarn` Then, compile the plugin: `npm run build` This will create some files in the directory: ``` main.js styles.css manifest.json ``` Copy these files into `your_vault_directory/.obsidian/plugins/obsidian-plugin-name`. Restart Obsidian. ### Commit Commit your changes to your repository: ``` git add . git commit -m 'Commit message' git push ``` ### Create a pull request Navigate to your forked repo on GitHub, and create a pull request by clicking the "Contribute" button next to your commit. Fill in the fields and hit Submit!