Contributing Guide

This documentation is open source and we welcome contributions from the community. Whether you're fixing a typo, adding examples, or writing new sections, your help makes these docs better for everyone.

🔒 SECURITY FIRST

⚠️ CRITICAL: This is a PUBLIC repository. Never commit sensitive information!

Quick Security Checklist:

• ✅ No API keys, tokens, or credentials

• ✅ No internal company data or strategies

• ✅ No .env files or config with secrets

• ✅ All examples use placeholder values

→ Read Full Security Guidelines

🚀 Quick Start

1. Fork the Repository

Visit https://github.com/taskade/docs and click "Fork" to create your own copy.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/docs.git
cd docs

3. Make Your Changes

Edit the markdown files using your preferred editor. All documentation is written in standard Markdown.

4. Test Your Changes

Preview your changes locally if possible, or check that links work and formatting is correct.

5. Submit a Pull Request

Push your changes and create a pull request with a clear description of what you've improved.

📝 What You Can Contribute

Documentation Improvements

• Fix typos and grammatical errors

• Improve clarity and readability

• Add missing information

• Update outdated content

Code Examples

• Add practical code examples

• Improve existing examples

• Add examples for different programming languages

• Create complete workflow examples

Integration Documentation

• Document new integrations

• Add setup guides for specific tools

• Share automation recipes

• Create troubleshooting guides

Visual Content

• Create diagrams and flowcharts

• Add screenshots for setup guides

• Design infographics for complex concepts

• Improve existing visual content

📋 Contribution Guidelines

Writing Style

• Use clear, concise language

• Write for developers of all skill levels

• Include practical examples

• Use active voice when possible

• Keep sentences and paragraphs short

Code Examples

• Include complete, working examples

• Add comments to explain complex logic

• Use realistic data in examples

• Test all code examples before submitting

Formatting

• Use proper Markdown syntax

• Include code language tags for syntax highlighting

• Use consistent heading levels

• Add line breaks for readability

Links and References

• Use relative links for internal documentation

• Verify all external links work

• Include relevant help center articles

• Add links to related API endpoints

🗂️ Documentation Structure

Main Sections

• vision/ - High-level vision and architecture

• genesis/ - No-code creation platform

• taskos/ - AI App Generator documentation

• automation/ - Automation engine and integrations

• api/ - API reference and guides

• start/ - Getting started guides

File Naming

• Use lowercase with hyphens: my-new-guide.md

• Be descriptive: github-integration-setup.md

• Group related files in folders

• Use README.md for section overviews

Content Organization

• Start with overview and use cases

• Include step-by-step instructions

• Add troubleshooting sections

• End with related resources

🔄 Review Process

Automated Checks

All pull requests are automatically checked for:

• Markdown formatting

• Link validity

• Spelling and grammar

• Code example syntax

Manual Review

Our team reviews contributions for:

• Technical accuracy

• Clarity and usefulness

• Consistency with existing docs

• Completeness of examples

Feedback and Iteration

• We'll provide constructive feedback

• Multiple rounds of review are normal

• We're here to help improve your contribution

• Don't be discouraged by change requests

🏆 Recognition

Contributors

All contributors are recognized in our:

• GitHub contributors list

• Documentation changelog

• Community highlights

• Annual contributor awards

Community Champions

Outstanding contributors may be invited to:

• Join our documentation team

• Participate in early feature previews

• Speak at Taskade events

• Collaborate on special projects

🎯 Priority Areas

We especially welcome contributions in these areas:

High Priority

• Automation recipes and examples

• Integration setup guides

• Troubleshooting documentation

• API usage examples

Medium Priority

• Visual diagrams and flowcharts

• Video tutorials and walkthroughs

• Community-requested features

• Performance optimization guides

Ongoing Needs

• Keeping examples up-to-date

• Fixing broken links

• Improving search functionality

• Translation to other languages

🐛 Reporting Issues

Found a Problem?

If you find issues but can't fix them yourself:

1. Check existing issues at github.com/taskade/docs/issues

2. Create a new issue with:

   • Clear description of the problem

   • Steps to reproduce (if applicable)

   • Suggested solution (if you have one)

   • Screenshots or examples

Issue Labels

• bug - Something is broken

• enhancement - Improvement suggestion

• documentation - Documentation issue

• good first issue - Good for new contributors

• help wanted - We need community help

💡 Suggesting New Content

Content Requests

To suggest new documentation:

1. Check the roadmap in our issues

2. Create a content request with:

   • What should be documented

   • Why it's important

   • Who would benefit

   • Outline or structure ideas

Popular Requests

Current community requests include:

• More automation examples

• Integration troubleshooting

• Advanced API usage patterns

• Performance optimization guides

💬 Providing Feedback and Suggestions for Taskade

Your feedback helps us build a better Taskade! We welcome suggestions, bug reports, and feature requests from our community.

Every suggestion, whether it's a small improvement or a major feature idea, helps shape the future of remote work and productivity tools.

Sharing Your Love for Taskade

Love using Taskade? Here's how you can help spread the word and support our growth:

⭐ Leave App Store Reviews

Your positive reviews help others discover Taskade:

• App Store: Search for "Taskade" and leave a 5-star review

• Google Play: Find Taskade and share your experience

• Why it matters: Reviews help new users find our apps in searches

📱 Share on Social Media

Spread the Taskade love on your favorite platforms:

• Twitter/X: Tag us @taskade and share your favorite features

• LinkedIn: Share how Taskade improves your productivity

• Facebook: Join our community and share your workflows

• Instagram: Screenshot your beautiful projects and tag us

💎 Upgrade Your Account

Support our development by upgrading to premium:

• Enhanced features: AI agents, unlimited projects, advanced automations

• Priority support: Faster response times and dedicated assistance

• Early access: New features before they're publicly released

Ready to upgrade? Visit taskade.com/pricing to see premium plans.

📖 Tell Your Network

Share Taskade with friends, colleagues, and communities:

• Team adoption: Introduce Taskade to your workplace

• Industry groups: Recommend it in professional communities

• Student groups: Share with classmates and study groups

• Word of mouth: The best marketing is personal recommendation

How to Share Your Ideas

Method 1: Email Support

Send your questions and suggestions directly to our team:

• Email: [email protected]

• Best for: Detailed feedback, bug reports, and complex suggestions

Method 2: Contact Form

Use our official contact page for structured feedback:

• Visit: taskade.com/contact

• Best for: Feature requests, partnership inquiries, and general feedback

Method 3: Feedback Channel

Join our active community feedback platform:

• Visit: taskade.com/feedback/feature-requests

• Best for: Submitting bugs, voting on feature requests, and tracking community suggestions

What Makes a Great Suggestion?

Clear and Specific

Instead of "Make it better," try:

• ✅ Good: "Add keyboard shortcut Ctrl+Shift+N to create a new project from any view"

• ❌ Too vague: "The interface needs improvement"

Include Context

Help us understand your use case:

• Your role: "As a project manager..."

• Current workflow: "Currently I have to..."

• Desired outcome: "It would be great if..."

Provide Examples

• Screenshots of current behavior

• Mockups of proposed changes

• Similar features from other tools you like

Types of Feedback We Love

Feature Requests

• New functionality you'd like to see

• Improvements to existing features

• Integration requests with other tools

• Workflow enhancements

Bug Reports

• Steps to reproduce the issue

• Expected vs. actual behavior

• Browser/device information

• Screenshots or screen recordings

UX Improvements

• Confusing workflows

• Missing keyboard shortcuts

• Mobile experience issues

• Accessibility concerns

Performance Feedback

• Slow loading times

• Memory usage issues

• Offline functionality gaps

• Large project handling

Community Engagement

Join the Conversation

Connect with other Taskade users and share your ideas:

• Facebook: facebook.com/taskade

• Reddit: reddit.com/r/Taskade/

• YouTube: youtube.com/taskade

Why Community Feedback Matters

• Prioritization: Popular requests get attention faster

• Validation: See if others share your needs

• Collaboration: Work together on solutions

• Updates: Get notified when features are implemented

What Happens to Your Feedback?

Our Review Process

1. Initial Triage: Team reviews within 24-48 hours

2. Categorization: Bugs, features, or improvements

3. Community Voting: Popular requests rise to the top

4. Implementation Planning: Added to our development roadmap

5. Updates: You'll receive status notifications

Response Times

• Bug Reports: Acknowledged within 24 hours

• Feature Requests: Reviewed within 1 week

• Complex Suggestions: May take longer for thorough evaluation

Implementation Timeline

Quick Wins (Days to Weeks)

• Bug fixes and small improvements

• Minor UI/UX enhancements

• Simple feature additions

Major Features (Weeks to Months)

• Complex new functionality

• Major workflow changes

• Large integrations

Strategic Initiatives (Months to Quarters)

• Platform-wide changes

• Major architectural updates

• New product categories

Recognition and Impact

Your Contribution Matters

• Every suggestion helps us understand user needs

• Community input shapes our product roadmap

• Active contributors may be featured in our community highlights

• Top suggesters sometimes get early access to new features

Track Your Impact

• Feedback Channel: Vote on and track your suggestions

• Changelog: See when your ideas become reality at taskade.com/blog/updates

• Community: Share success stories when your suggestions are implemented

Best Practices for Effective Feedback

Be Constructive

• Focus on problems and solutions, not just complaints

• Acknowledge what works well before suggesting improvements

• Consider the broader impact on all users

Stay Engaged

• Follow up on your suggestions periodically

• Provide additional context if requested

• Update your requests based on new information

Collaborate with Others

• Upvote similar suggestions to increase visibility

• Combine related ideas into comprehensive requests

• Share workarounds while waiting for official solutions

---

Ready to share your ideas? Let's shape the future of remote work together! 🎉

Whether it's a small tweak or a game-changing feature, your feedback helps make Taskade better for everyone. We read every suggestion and use them to guide our development priorities.

🛠️ Technical Setup

Local Development

For advanced contributors who want to preview changes:

# Install GitBook CLI (optional)
npm install -g gitbook-cli

# Serve documentation locally
gitbook serve

# Build static site
gitbook build

Markdown Extensions

We support standard Markdown plus:

• Code syntax highlighting

• Mermaid diagrams

• Table formatting

• Emoji shortcodes

📞 Getting Help

Community Support

• Taskade Community Forum

• Discord Server

• GitHub Discussions

Direct Contact

• Email: [email protected]

• Twitter: @taskade

• GitHub: @taskade

📜 License

By contributing to this documentation, you agree that your contributions will be licensed under the same license as the project.

---

🙏 Thank You

Every contribution, no matter how small, helps make Taskade better for everyone. We're grateful for your time and effort in improving our documentation.

Ready to contribute? → Browse open issues

Have questions? → Join our community

Want to suggest new content? → Create a content request