Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (46 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 2.17 KB

Contributing to CredFinder

Thank you for your interest in contributing to CredFinder! This document provides guidelines and instructions for contributing.

Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.

How Can I Contribute?

Reporting Bugs

If you find a bug, please create an issue with the following information:

  • A clear, descriptive title
  • Steps to reproduce the issue
  • Expected behavior vs. actual behavior
  • Your environment details (OS, shell version, etc.)
  • Any relevant logs or screenshots

Suggesting Enhancements

We welcome suggestions for enhancements! Please create an issue that includes:

  • A clear, descriptive title
  • A detailed description of the proposed enhancement
  • Any potential implementation details or ideas
  • Why this enhancement would be useful to most users

Pull Requests

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Write your code and add tests if applicable
  4. Make sure your code lints and follows the project style
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Styleguides

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

Bash Script Style

  • Use 4 spaces for indentation (not tabs)
  • Add comments for complex logic
  • Use uppercase for constants and lowercase for variables
  • Include error handling for commands that might fail
  • Follow defensive programming practices for user input

Additional Notes

Performance Considerations

  • Be mindful of performance when modifying the scanning functionality
  • Test with large repositories to ensure changes don't degrade performance

Security

  • Ensure any changes maintain or improve the security of the tool
  • Be careful with external dependencies and execution of user-provided input

Thank you for contributing to CredFinder!