Skip to content

Latest commit

 

History

History
149 lines (120 loc) · 4.11 KB

CONTRIBUTING.md

File metadata and controls

149 lines (120 loc) · 4.11 KB

Contributing to CipherSmith 🔐

First off, thank you for considering contributing to CipherSmith! It's people like you that make CipherSmith such a great tool.

Code of Conduct 📜

By participating in this project, you are expected to uphold our Code of Conduct:

  • Be respectful and inclusive
  • Exercise consideration and empathy
  • Focus on what is best for the community
  • Use welcoming and inclusive language

How Can I Contribute? 🤝

Reporting Bugs 🐛

Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:

  1. Use a clear and descriptive title
  2. Describe the exact steps to reproduce the problem
  3. Provide specific examples
  4. Include:
    • Your Python version
    • CipherSmith version
    • Operating system
    • Error messages (if any)
    • Screenshots (if applicable)

Suggesting Enhancements ✨

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion:

  1. Use a clear and descriptive title
  2. Provide a step-by-step description of the suggested enhancement
  3. Explain why this enhancement would be useful
  4. List some examples of how it would be used

Pull Requests 📥

  1. Fork the repository

  2. Create a new branch:

    git checkout -b feature/your-feature-name

  3. Make your changes

  4. Run tests:

    pytest

  5. Update documentation if needed

  6. Commit your changes:

    git commit -m "feat: Add some feature"

    Follow our commit message conventions:

    • feat: for new features
    • fix: for bug fixes
    • docs: for documentation changes
    • test: for test changes
    • refactor: for code refactoring
    • style: for formatting changes
    • chore: for maintenance tasks

  7. Push to your fork:

    git push origin feature/your-feature-name

  8. Open a Pull Request

Development Setup 🛠️

  1. Clone the repository:

    git clone https://github.com/YourUsername/CipherSmith.git
cd CipherSmith

  2. Create a virtual environment:

    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

  3. Install dependencies:

    pip install -r requirements.txt
pip install -e .  # Install in development mode

  4. Install development dependencies:

    pip install -r requirements-dev.txt

Code Style 🎨

  • Follow PEP 8 guidelines
  • Use Black for code formatting
  • Use type hints where possible
  • Write docstrings for functions and classes
  • Add comments for complex logic

Project Structure 📁

CipherSmith/
├── .github/                # GitHub specific files
│   └── workflows/         # GitHub Actions workflows
├── app/                   # Main application directory
│   ├── __init__.py
│   ├── main.py           # Core application logic
│   ├── database.py       # Database operations
│   └── password_strength.py  # Password analysis
├── docs/                  # Documentation files
│   ├── CHANGELOG.md      # Version history
│   ├── CONTRIBUTING.md   # Contribution guidelines
│   ├── DEMO.md          # Usage examples
│   └── INSTALL.md       # Installation guide
├── .gitignore            # Git ignore rules
├── LICENSE               # Project license
├── MANIFEST.ini          # Package manifest
├── README.md            # Project overview
├── pyproject.toml       # Project configuration
├── requirements.txt     # Project dependencies
└── setup.py            # Package setup file

Documentation 📚

  • Update documentation for new features
  • Include docstrings in code
  • Update README.md if needed
  • Add examples for new functionality

Need Help? 🤔

Feel free to:

  • Open an issue with your question
  • Join our discussions
  • Contact maintainers

Recognition 🌟

Contributors will be:

  • Listed in our README.md
  • Mentioned in release notes
  • Added to contributors list

Thank you for contributing to CipherSmith! 🙏