Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (52 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

74 lines (52 loc) · 2.53 KB
Raw

Contributing to PassGen

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

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.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include your system details (OS, Rust version, etc.)

Suggesting Enhancements

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

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and explain which behavior you expected to see instead
  • Explain why this enhancement would be useful

Pull Requests

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. If you've changed APIs, update the documentation
  4. Ensure the test suite passes
  5. Make sure your code follows the existing style (run cargo fmt)
  6. Issue that pull request!

Development Setup

  1. Install Rust (https://rustup.rs/)
  2. Clone your fork
  3. Run cargo build to build the project
  4. Run cargo test to run the tests
  5. Run cargo fmt to format your code
  6. Run cargo clippy to check for common mistakes

Style Guidelines

Git 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 or less
  • Reference issues and pull requests liberally after the first line

Rust Style Guide

  • Follow the official Rust style guide
  • Use cargo fmt before committing
  • Use cargo clippy and address any warnings
  • Write tests for new functionality
  • Document public APIs with doc comments

Testing

  • Write unit tests for new functionality
  • Ensure all tests pass with cargo test
  • Add integration tests for complex features
  • Test on different platforms if possible

Thank you for contributing!