Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
210 lines (163 loc) · 6.25 KB

CONTRIBUTING.md

File metadata and controls

210 lines (163 loc) · 6.25 KB

🤝 Contributing to DevDunia

Thank you for your interest in contributing to DevDunia! We welcome contributions from the community and appreciate your help in making this project better.

🚀 Quick Start

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-tool)
  3. Make your changes
  4. Test thoroughly
  5. Commit your changes (git commit -m 'Add amazing tool')
  6. Push to the branch (git push origin feature/amazing-tool)
  7. Open a Pull Request

🛠️ Ways to Contribute

🆕 Add New Tools

  • New utility tools - Add tools that developers commonly need
  • Improve existing tools - Enhance functionality or UI/UX
  • Bug fixes - Fix issues and improve reliability
  • Performance improvements - Optimize existing code

📝 Documentation

  • README improvements - Better descriptions and examples
  • Code comments - Explain complex logic
  • Tutorials - How-to guides for using tools
  • API documentation - Document tool interfaces

🎨 UI/UX Improvements

  • Better design - Improve visual appeal
  • Responsive design - Ensure mobile compatibility
  • Accessibility - Make tools accessible to everyone
  • User experience - Improve usability

🧪 Testing

  • Test cases - Add tests for new features
  • Bug reports - Report issues you find
  • Cross-browser testing - Ensure compatibility
  • Performance testing - Check tool performance

📋 Tool Development Guidelines

🎯 Tool Requirements

  • Single purpose - Each tool should do one thing well
  • Fast execution - Tools should be instant and responsive
  • Clear interface - Easy to understand and use
  • Error handling - Graceful error messages
  • Mobile friendly - Work on all devices

🏗️ File Structure

devdunia/
├── tool-name.html          # Main tool file
├── images/                 # Tool-specific images
└── js/                     # Tool-specific JavaScript

📝 Naming Conventions

  • File names: kebab-case (e.g., json-formatter.html)
  • Tool names: Clear and descriptive
  • CSS classes: Follow Tailwind conventions
  • JavaScript: Use camelCase for variables

🎨 Design Standards

  • Consistent styling - Use Tailwind CSS classes
  • Dark theme - Match the existing design
  • Responsive - Work on mobile and desktop
  • Accessible - Proper ARIA labels and keyboard navigation

🧪 Testing Your Changes

✅ Before Submitting

  • Test on multiple browsers (Chrome, Firefox, Safari, Edge)
  • Test on mobile devices
  • Check for console errors
  • Validate HTML and CSS
  • Test with different input types
  • Ensure error handling works

🔍 Code Quality

  • Clean, readable code
  • Proper comments
  • No console.log statements
  • Efficient algorithms
  • Proper error handling

📝 Pull Request Guidelines

📋 PR Template

## Description
Brief description of changes

## Type of Change
- [ ] New tool
- [ ] Bug fix
- [ ] Documentation update
- [ ] UI/UX improvement
- [ ] Performance optimization

## Testing
- [ ] Tested on multiple browsers
- [ ] Tested on mobile
- [ ] No console errors
- [ ] All functionality works

## Screenshots (if applicable)
Add screenshots of UI changes

## Additional Notes
Any additional information

✅ PR Requirements

  • Clear description - Explain what you changed and why
  • Testing - Show that your changes work
  • Screenshots - For UI changes
  • No conflicts - Ensure your branch is up to date
  • Small changes - Keep PRs focused and manageable

🐛 Reporting Issues

🚨 Bug Reports

When reporting bugs, please include:

  • Browser and version
  • Operating system
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Screenshots (if applicable)

💡 Feature Requests

For new features, please include:

  • Use case - Why is this needed?
  • Proposed solution - How should it work?
  • Alternatives - Other ways to solve this?
  • Additional context - Any other relevant information

🏷️ Issue Labels

We use labels to categorize issues:

  • bug - Something isn't working
  • enhancement - New feature or request
  • documentation - Improvements to documentation
  • good first issue - Good for newcomers
  • help wanted - Extra attention is needed
  • question - Further information is requested

🎯 Good First Issues

Looking for your first contribution? Check out these labels:

  • good first issue - Perfect for beginners
  • documentation - Great way to get familiar with the project
  • bug - Small fixes that help you understand the codebase

💬 Getting Help

🤝 Community

  • GitHub Discussions - Ask questions and get help
  • Issues - Report bugs and request features
  • Pull Requests - Discuss changes and improvements

📧 Contact

🏆 Recognition

🌟 Contributors

All contributors will be:

  • Listed in README - Recognition for your work
  • Mentioned in releases - Credit for contributions
  • Invited to maintainer team - For significant contributions

🎁 Rewards

  • Swag - DevDunia stickers and merchandise
  • Recognition - Featured on our website
  • Networking - Connect with other developers
  • Learning - Improve your skills and portfolio

📜 Code of Conduct

🤝 Our Pledge

We are committed to providing a welcoming and inspiring community for all. Please read and follow our Code of Conduct.

🚫 Unacceptable Behavior

  • Harassment or discrimination
  • Trolling or inflammatory comments
  • Personal attacks or insults
  • Spam or off-topic discussions

📄 License

By contributing to DevDunia, you agree that your contributions will be licensed under the MIT License.

🙏 Thank You

Thank you for contributing to DevDunia! Your contributions help make this project better for developers worldwide.

Happy coding! 🚀

Made with ❤️ by the DevDunia community

Empowering developers worldwide with free, open-source tools