Skip to content

docs: Create missing project files (LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md) #49

Description

@YaronZaki

Problem Statement

Four critical community health files missing from repository root: LICENSE (README says MIT but file doesn't exist), CONTRIBUTING.md (no contributor workflow docs), CODE_OF_CONDUCT.md (no community standards), SECURITY.md (no vulnerability disclosure policy). Project fails GitHub community standards check.

Evidence

# README.md references MIT License but:
# No `LICENSE` file exists in repository root
# No `CONTRIBUTING.md` exists
# No `CODE_OF_CONDUCT.md` exists
# No `SECURITY.md` exists

Impact

High — open-source adoption blocker. No legal clarity on licensing despite README claim. No contributor onboarding guidance. No responsible disclosure channel for security researchers — vulnerabilities may be disclosed publicly without a fix window.

Proposed Solution

Create: (1) LICENSE — MIT license text, (2) CONTRIBUTING.md — PR workflow, local setup, testing requirements, code style, (3) CODE_OF_CONDUCT.md — Contributor Covenant 2.1, (4) SECURITY.md — disclosure email, 90-day response timeline.

Acceptance Criteria

  • LICENSE file exists with complete MIT license text matching README claim
  • CONTRIBUTING.md explains PR process, local setup (make dev), testing (poetry run pytest), code style (pylint, pre-commit)
  • CODE_OF_CONDUCT.md adopts Contributor Covenant 2.1 with enforcement contact
  • SECURITY.md provides disclosure email and 90-day response timeline
  • README.md references all four new files

File Map

  • LICENSENew file
  • CONTRIBUTING.mdNew file
  • CODE_OF_CONDUCT.mdNew file
  • SECURITY.mdNew file
  • README.md — add references to new files

Testing Strategy

Manual review of file content and GitHub community profile completeness check.

Security Considerations

SECURITY.md enables responsible disclosure — critical for a DeFi protocol.

Definition of Done

  • Files created and committed
  • PR linked and merged

Getting Started (New Contributors)

Recommended reading: README.md for project overview, docs/environment_variables.md for configuration.
Suggested first steps: (1) Read existing README to verify MIT claim, (2) Copy MIT license from opensource.org/licenses/MIT, (3) Create CONTRIBUTING.md following patterns in .github/ISSUE_TEMPLATE/, (4) Copy Contributor Covenant 2.1, (5) Create SECURITY.md with disclosure instructions.
Estimated time: 2 hours


Labels: open-source, documentation, good-first-issue
Priority: High
Difficulty: Beginner
Estimated Effort: 2h

Metadata

Metadata

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions