Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 2.49 KB

Contributing.md

File metadata and controls

80 lines (56 loc) · 2.49 KB
Raw

Contributing to Password Generator

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

📋 Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. How Can I Contribute?
  4. Style Guidelines
  5. Pull Request Process

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/Password-Generator.git
  3. Create a new branch: git checkout -b feature/YourFeatureName
  4. Make your changes
  5. Test your changes thoroughly
  6. Commit your changes: git commit -m 'Add some feature'
  7. Push to the branch: git push origin feature/YourFeatureName
  8. Open a Pull Request

How Can I Contribute?

🐛 Reporting Bugs

  • Use the GitHub issue tracker
  • Describe the bug & how to reproduce it
  • Include browser & OS information
  • Add screenshots if applicable

💡 Suggesting Enhancements

  • Use the GitHub issue tracker
  • Provide a clear description of the enhancement
  • Explain why this enhancement would be useful

👩‍💻 Pull Requests

  1. Follow our style guidelines
  2. Document new code
  3. Update README.md if needed
  4. Add tests for new features

Style Guidelines

💻 Code Style

  • Use 2 spaces for indentation
  • Use camelCase for variable and function names
  • Add comments for complex logic
  • Keep functions small and focused

📝 Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters
  • Reference issues and pull requests

Pull Request Process

  1. Update the README.md with details of changes if applicable
  2. Update the version numbers following SemVer
  3. The PR will be merged once you have the sign-off of at least one other developer

📋 Issue Labels

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

Thank you for contributing to Password Generator! 🎉