Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
241 lines (189 loc) · 5.61 KB

CONTRIBUTING.md

File metadata and controls

241 lines (189 loc) · 5.61 KB

Contributing to Quantum Language

Thank you for your interest in contributing to Quantum Language! 🚀

🌟 How to Contribute

⭐ Star the Repository

The easiest way to support this project is by starring the repository on GitHub. This helps:

  • Increase project visibility
  • Show your appreciation for the work
  • Help others discover the Quantum Language

🍴 Fork and Contribute

We welcome contributions through GitHub forks! Here's how you can contribute:

1. Fork the Repository

  1. Visit Quantum Language on GitHub
  2. Click the "Fork" button in the top-right corner
  3. This creates a personal copy of the repository

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/Quantum-Language.git
cd Quantum-Language

3. Create a Feature Branch

git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

4. Make Your Changes

  • Code changes
  • Documentation updates
  • Bug fixes
  • New features
  • Test improvements

5. Test Your Changes

# Build the project
.\build.bat

# Test the compiler
.\quantum.exe --version
.\quantum.exe examples\hello.sa

6. Commit Your Changes

git add .
git commit -m "feat: add your feature description"

7. Push to Your Fork

git push origin feature/your-feature-name

8. Create a Pull Request

  1. Visit your fork on GitHub
  2. Click the "New Pull Request" button
  3. Provide a clear title and description
  4. Wait for review and feedback

📋 Contribution Guidelines

🎯 Areas Where We Need Help

1. Core Compiler Development

  • Parser improvements
  • New language features
  • Performance optimizations
  • Bug fixes

2. Standard Library

  • Built-in functions
  • Mathematical operations
  • String manipulation
  • File I/O operations

3. Cybersecurity Features 🛡️

  • Network scanning functions
  • Encryption/decryption
  • Hashing algorithms
  • Security utilities

4. Documentation

  • Improve README.md
  • Write tutorials
  • Create examples
  • Update API documentation

5. VS Code Extension

  • Better syntax highlighting
  • More code snippets
  • Debugging support
  • Language server features

6. Testing

  • Unit tests
  • Integration tests
  • Performance benchmarks
  • Regression tests

7. Build System

  • CI/CD improvements
  • Cross-platform builds
  • Package management
  • Installation scripts

📝 Coding Standards

C++ Code Style

  • Use C++17 features
  • Follow Google C++ Style Guide
  • Use 4 spaces for indentation (no tabs)
  • Add comments for complex logic
  • Include unit tests for new features

Commit Message Format

type: description

feat: add new feature
fix: resolve bug in lexer
docs: update README
test: add unit tests
refactor: improve code structure

File Organization

  • Header files in include/
  • Source files in src/
  • Examples in examples/
  • Documentation in docs/
  • Tests in tests/

🐛 Bug Reports

When reporting bugs, please include:

  1. Quantum Language version
  2. Operating system
  3. Minimal reproduction code
  4. Expected vs actual behavior
  5. Error messages

💡 Feature Requests

For new features, please:

  1. Check existing issues first
  2. Describe the use case
  3. Propose implementation ideas
  4. Consider backwards compatibility

📚 Documentation Contributions

  • README improvements
  • Code examples
  • Tutorial creation
  • API documentation
  • Architecture documentation

🏆 Recognition

All contributors will be:

  • Listed in the README.md contributors section
  • Mentioned in release notes
  • Given appropriate GitHub credit
  • Invited to join the core team for significant contributions

🤝 Community Guidelines

Be Respectful

  • Treat everyone with respect
  • Welcome newcomers
  • Provide constructive feedback
  • Be patient and helpful

Communication

  • Use GitHub Issues for bug reports
  • Use Discussions for questions
  • Be clear and concise
  • Provide context when needed

Code Review Process

  • All PRs require review
  • Be responsive to feedback
  • Test thoroughly before submission
  • Update documentation as needed

🚀 Quick Start for Contributors

  1. ⭐ Star the repository
  2. 🍴 Fork the project
  3. 🔧 Set up development environment
  4. 📝 Choose an issue or create one
  5. 💻 Make your changes
  6. 🧪 Test thoroughly
  7. 📤 Submit a pull request

📞 Get Help

  • GitHub Issues: Report bugs and request features
  • GitHub Discussions: Ask questions and share ideas
  • Email: muhammad.saad.amin@example.com
  • Discord: [Join our Discord server]

🎁 Special Recognition

Top Contributors

  • ⭐ Star Gazers: Thank you for supporting the project!
  • 🍴 Fork Heroes: Thank you for contributing code!
  • 🐛 Bug Hunters: Thank you for finding and fixing issues!
  • 📚 Documentation Wizards: Thank you for improving docs!

Hall of Fame

Contributors who make significant impacts will be featured in:

  • README.md Hall of Fame section
  • Release notes acknowledgments
  • Social media shoutouts
  • Annual report recognition

🌈 Thank You!

Every contribution matters! Whether it's:

  • A ⭐ star to show support
  • A 🐛 bug report to improve quality
  • A 💻 code contribution to add features
  • A 📚 documentation improvement to help others
  • A 🗣️ community help to support users

Thank you for being part of the Quantum Language community! 🚀

"Quantum Language: Where Cybersecurity Meets Programming" 🛡️💻