Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (34 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 1.17 KB
Raw

Contributing to Scayid

Thank you for considering contributing to Scayid! 🎉

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YourUsername/Scayid.git
  3. Create a virtual environment: python -m venv venv
  4. Activate it: source venv/bin/activate (Linux/Mac) or venv\Scripts\activate (Windows)
  5. Install dependencies: pip install -r requirements.txt

Development Guidelines

Code Style

  • Follow PEP 8 guidelines
  • Use meaningful variable names
  • Add comments for complex logic
  • Maintain the hacker aesthetic in UI outputs

Making Changes

  1. Create a new branch: git checkout -b feature/your-feature-name
  2. Make your changes
  3. Test your changes: python scayid.py -g
  4. Commit with a clear message
  5. Push to your fork and create a Pull Request

Testing

Before submitting a PR, ensure:

  • Code runs without errors
  • All existing features work
  • New features are documented
  • README is updated if needed

Code of Conduct

  • Be respectful
  • Welcome newcomers
  • Focus on constructive feedback

Questions?

Feel free to open an issue or contact Scayar directly.

Made with ❤️ by Scayar