Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (35 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

54 lines (35 loc) · 1.9 KB

Contributing to Encryptable

Thank you for your interest in contributing to Encryptable! We welcome bug reports, feature requests, documentation improvements, and code contributions from the community.

How to Contribute

  • Bug Reports:

  1. Bug Reports:

    • Please open a GitHub Issue and use the "bug" label.
    • Include clear steps to reproduce, expected behavior, and actual behavior.
    • Attach logs, stack traces, or screenshots if possible.

  2. Feature Requests:

    • Open a GitHub Issue and use the "enhancement" label.
    • Describe your use case and why the feature would be valuable.

  • Pull Requests:

    • Fork the repository and create a new branch for your changes.
    • Write clear, concise commit messages.
    • Add or update tests as appropriate.
    • Ensure all tests pass before submitting your PR.
    • Reference the related issue in your PR description.

  • Documentation:

    • Improvements to documentation are always welcome!
    • Fix typos, clarify explanations, or add new examples.

Code Style & Standards

  • Follow the existing code style and conventions.
  • Use descriptive variable and function names.
  • Write clear, maintainable, and well-documented code.
  • Keep pull requests focused and minimal—avoid unrelated changes.

Code of Conduct

All contributors are expected to follow the Code of Conduct to ensure a welcoming and respectful environment.

Reporting Conduct Issues

If you experience or witness unacceptable behavior, please open a GitHub issue of type "conduct." The maintainer is obligated to respect the privacy and security of the reporter. If you are not comfortable reporting publicly, you may contact the maintainer directly via GitHub.

Thank you for helping make Encryptable better!