Skip to content

docs: add CONTRIBUTING.md with setup, code style, and PR guide#7

Open
Oval17 wants to merge 1 commit into
theapprenticeproject:mainfrom
Oval17:docs/add-contributing-guide
Open

docs: add CONTRIBUTING.md with setup, code style, and PR guide#7
Oval17 wants to merge 1 commit into
theapprenticeproject:mainfrom
Oval17:docs/add-contributing-guide

Conversation

@Oval17
Copy link
Copy Markdown

@Oval17 Oval17 commented May 3, 2026

Covers:

  • Local setup steps including the required manual folder creation (sites//public/files/original and /processed) — a common stumbling block for new contributors
  • Ruff lint and format commands (Python style enforced in this project)
  • Conventional Commits format with type reference table
  • Pre-commit hook installation (ruff runs on every commit)
  • PR submission checklist and description template
  • Bug report format
  • Project structure overview with key concept notes

I have used general template , if there are any specific requirements or required, really happy to do it.
Thanks

Covers:
- Local setup steps including the required manual folder creation
  (sites/<name>/public/files/original and /processed) — a common
  stumbling block for new contributors
- Ruff lint and format commands (Python style enforced in this project)
- Conventional Commits format with type reference table
- Pre-commit hook installation (ruff runs on every commit)
- PR submission checklist and description template
- Bug report format
- Project structure overview with key concept notes
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.

1 participant