CONTRIBUTING.md

---

---

This page is a work-in-progress

Resources for working w/README.md

• github.com > Basic writing and formatting syntax
• github.com > Autolinked references and URLs

GitHub Actions

if you feel like playing around with any of these on a PR (pull request)

• May be useful for generating table of contents
  • github.com > TOC Generator - GitHub Marketplace - Currently using this one
  • github.com > md-toc-action - GitHub Marketplace
  • github.com > DOCTOC Action - GitHub Marketplace
  • github.com > Markdown auto catalog · Actions · GitHub Marketplace
  • github.com > Markdown Table of Contents Generator - GitHub Marketplace

Thank you for your interest in contributing! 🎉 We welcome links to your own public Obsidian vaults (not raw folders) so others can explore real‑world examples and use them as inspiration.

---

1. Before You Begin

1. Fork this repository
2. Clone your fork locally
3. Create a feature branch:

   git checkout -b add-your-vault

---

2. How to Submit Your Vault Example

1. In your fork, navigate to the Community-Shares/ folder.
2. Create a new directory named after your GitHub username, for example:

Community-Shares/your-github-username/

• Inside that directory, add a README.md containing:
  • A link to your public vault (e.g. https://github.com/you/your-vault)
  • A short description (1–2 sentences)
  • One or more categories/tags (e.g., #starter-vault, #mobile-vault, #secops)
• (Optional) Include additional files:
  • plugin-favorites.md – your curated list of plugins
  • web-clipper-template.md – your custom web‑clipper settings
• Ensure the top of your README has a TOC comment so our GitHub Action can update it:

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- END doctoc generated TOC please keep comment here to allow auto update -->

---

3. Submission Checklist

Before opening your Pull Request:

• You’ve forked the repo and are on a separate branch
• Your files live under Community-Shares/your-github-username/
• Your README.md includes link, description, and tags
• (Optional) Additional template files are in plac
• You’ve left TOC placeholders for our Action (copy and paste to top of page from above)

---

4. License

By contributing, you agree that your vault links and any added files are licensed under this project’s LICENSE.