Skip to content

docs: add Code of Conduct, License, Security Policy, and templates - #20

Merged
KHolodilin merged 6 commits into
mainfrom
feature/issue-3-add-project-documentation
Jan 23, 2026
Merged

docs: add Code of Conduct, License, Security Policy, and templates#20
KHolodilin merged 6 commits into
mainfrom
feature/issue-3-add-project-documentation

Conversation

@KHolodilin

Copy link
Copy Markdown
Owner

Description

Add essential project documentation files including Code of Conduct, License file, Security Policy, and GitHub templates for issues and pull requests. This improves project professionalism, provides clear guidelines for contributors, and streamlines the contribution process.

Changes Made

  • ✅ Added LICENSE file (MIT License)
  • ✅ Added CODE_OF_CONDUCT.md (Contributor Covenant 2.1)
  • ✅ Added SECURITY.md with vulnerability reporting process
  • ✅ Added GitHub issue templates:
    • bug_report.md - Bug report template
    • feature_request.md - Feature request template
    • question.md - Question template
    • config.yml - Issue template configuration
  • ✅ Added .github/pull_request_template.md - Pull Request template

Type of Change

  • Documentation update

Testing

  • All files properly formatted (Markdown)
  • Pre-commit checks pass
  • No linting errors

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my own code
  • I have updated the documentation accordingly
  • My changes generate no new warnings
  • Pre-commit hooks pass (pre-commit run --all-files)
  • Code formatting passes (ruff format --check .)
  • Linting passes (ruff check .)

Related Issue

Fixes #19

- Add LICENSE file (MIT License)
- Add CODE_OF_CONDUCT.md (Contributor Covenant 2.1)
- Add SECURITY.md with vulnerability reporting process
- Add GitHub issue templates (bug_report, feature_request, question)
- Add GitHub issue template config.yml
- Add pull request template
- Fix mixed line endings in all new files

Fixes #19
@codecov-commenter

codecov-commenter commented Jan 23, 2026

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 66.66667% with 2 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
email_processor/cli/commands/passwords.py 50.00% 2 Missing ⚠️

📢 Thoughts on this report? Let us know!

- Show clearer message when cryptography is not installed
- Provide installation instructions in the warning
- Keep generic error message for other encryption failures
@KHolodilin
KHolodilin merged commit 9c37bd7 into main Jan 23, 2026
14 checks passed
@KHolodilin
KHolodilin deleted the feature/issue-3-add-project-documentation branch January 23, 2026 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add project documentation and templates (Code of Conduct, License, Security Policy, Issue/PR templates)

2 participants