👨🏻‍💻 CONTRIBUTORS GUIDELINE 👨🏻‍💻

[jimenezz22]

Contributing Guide

🍴 Fork the Repository

1. Visit DojoByExample
2. Click the Fork button in the top-right corner

📥 Clone your fork

Clone your forked repository to your local machine:

git clone https://github.com/YOUR_USERNAME/DojoByExample.git

⭐️ Follow the installation guide here

🌿 Create a Branch

All branches must follow our naming convention and be in lowercase:

git checkout -b type/description

Branch types available:

• feat/user-registration 🚀 For new features
• fix/login-validation 🐛 For bug fixes
• docs/api-docs 📝 For documentation
• style/button-design 🎨 For styling
• refactor/auth-logic 🔄 For code refactoring
• perf/query-optimization ⚡ For performance
• test/user-tests ✅ For testing
• build/webpack-config 🏗️ For build changes
• ci/github-actions 🤖 For CI changes
• chore/deps-update 🧹 For maintenance

⚡ Make Atomic Commits

Each commit must be clear, descriptive, and follow our format:

git add .
git commit -m "type: description"

Example commits:

• feat: add nft minting functionality 🚀
• fix: resolve eth balance display error 🐛
• docs: update smart contract documentation 📝
• style: improve wallet connection modal 🎨
• refactor: optimize gas calculation logic 🔄
• test: add contract deployment tests ✅

🚀 Push Changes

Push your changes to your forked repository:

git push origin your-branch-name

Important: ⚠️ Be Respectful

📮 Create a Pull Request

1. Create a Pull Request (PR) targeting the main branch
2. Use our PR template (required)
3. Ensure all checks pass before requesting review ✅

🔍 Remember:

• All commits and branch names must be in lowercase 🔡
• Keep commits atomic and focused
• Follow our Git Guidelines strictly

Thanks for contributing to Dojo By Example ⛩️🥷🏻