Contributing to TeQoin Documentation

Thank you for contributing to TeQoin's documentation! 🎉

🤝 Code of Conduct

Be respectful, inclusive, and professional in all interactions.

🚀 Getting Started

Fork the repository
Clone your fork: git clone https://github.com/YOUR_USERNAME/docs.git
Create a feature branch: git checkout -b feature/your-feature
Make changes
Test locally: mintlify dev
Submit a pull request

🌿 Branch Naming Convention

Prefix	Purpose	Example
`feature/`	New content or features	`feature/api-reference`
`docs/`	Documentation updates	`docs/fix-typos`
`fix/`	Bug fixes	`fix/broken-links`
`style/`	Formatting/design	`style/update-colors`

📝 Commit Message Format

We follow Conventional Commits:

<type>(<scope>): <subject>

<body> (optional)

Types: docs, feat, fix, style, refactor, test, chore

Examples:

git commit -m "docs(api): add indexer endpoints documentation"
git commit -m "feat(tutorials): add smart contract deployment guide"
git commit -m "fix(quickstart): correct MetaMask network parameters"

🔄 Pull Request Process

Create PR to develop (not main)
Use conventional commit format for title
Describe changes clearly
List what you tested
Wait for review and approval

📚 Style Guide

Writing

Clear and concise - Avoid jargon
Active voice - "Deploy the contract"
Present tense - "The API returns"
Second person - "You can deploy"

Code Blocks

Always specify language:

const provider = new ethers.JsonRpcProvider('https://rpc.teqoin.io');

✅ Checklist

Thank you for contributing! 🚀

FilesExpand file tree

CONTRIBUTING.md

Latest commit

History