Skip to content

How to Contribute

Welcome to the Tsunami Knowledge Base! We're excited that you want to contribute to our community's collective knowledge. This guide will walk you through everything you need to know to make meaningful contributions.

🌟 Ways to Contribute

💬 Start with Discussions (Easiest)

Perfect for sharing ideas, asking questions, or providing feedback.

  • Share experiences from your projects
  • Ask questions about existing content
  • Propose new topics or improvements
  • Provide feedback on documentation

👉 Join our Discussions

✏️ Quick Edits (Beginner-friendly)

Small improvements and corrections can be made directly on GitHub.

  • Fix typos or broken links
  • Add missing information
  • Improve clarity of existing content
  • Update outdated information

📝 Major Contributions (More involved)

New content, restructuring, or significant additions.

  • Write new guides or practices
  • Create resource collections
  • Add templates and tools
  • Restructure existing content

🚀 Quick Start Guide

For Non-Technical Contributors

  1. Share Your Ideas 💡 Create a new discussion in the Ideas & Proposals category. Describe what you'd like to contribute and why it would be valuable

  2. Create Content ✍️ Write your content in Markdown format (we'll help with formatting). You can write in any text editor or directly in GitHub

  3. Submit 🔍 Create a pull request or ask a maintainer for help. Your content will be reviewed and refined together.

For Technical Contributors

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test locally (optional but recommended)
  5. Submit a pull request

🛠️ Technical Setup (Optional)

If you want to preview your changes locally:

Prerequisites

  • Python 3.7+
  • Git

Local Development Setup

# 1. Fork and clone the repository
git clone https://github.com/YOUR-USERNAME/tsunami-knowledge-base.git
cd tsunami-knowledge-base

# 2. Install dependencies
pip install -r requirements.txt

# 3. Serve the documentation locally
mkdocs serve

# 4. Open your browser to http://127.0.0.1:8000

Making Changes

# 1. Create a new branch
git checkout -b feature/your-contribution-name

# 2. Make your changes to files in the docs/ folder

# 3. Preview changes
mkdocs serve

# 4. Commit your changes
git add .
git commit -m "Add [description of your contribution]"

# 5. Push your branch
git push origin feature/your-contribution-name

# 6. Create a pull request on GitHub

🆘 Getting Help

For Content Questions

For Technical Issues

For Urgent Issues

  • Tag @maintainers in any discussion
  • Email the repository maintainers (check the repository README for contact info)

Questions? Start a discussion