Skip to content

Add CODE_OF_CONDUCT and CONTRIBUTING documentation - #9

Merged
Hum2a merged 1 commit into
enhancingfrom
github
Jul 3, 2026
Merged

Add CODE_OF_CONDUCT and CONTRIBUTING documentation#9
Hum2a merged 1 commit into
enhancingfrom
github

Conversation

@Hum2a

@Hum2a Hum2a commented Jul 3, 2026

Copy link
Copy Markdown
Owner
  • Introduced a Contributor Covenant Code of Conduct to establish community standards for respectful and inclusive participation.
  • Added a CONTRIBUTING.md file outlining the development workflow, code standards, and guidelines for submitting pull requests.
  • Updated README.md to link to the new CODE_OF_CONDUCT and CONTRIBUTING documents for better visibility.
  • Enhanced SECURITY.md to clarify the project's status as a take-home project and provide reporting channels for vulnerabilities.

Summary by cubic

Adds community standards and repo hygiene, and retools CI/CD to run heavy checks on main with streamlined staging/production deploys. Improves docs, templates, and security guidance to make contributions clear and safe.

  • New Features

    • Community + docs: CODE_OF_CONDUCT, CONTRIBUTING (workflow + DoD), SUPPORT; README links; new docs/GITHUB.md; deployment/env/runbook/checklists updated; clearer SECURITY reporting.
    • Issue/PR templates, CODEOWNERS, VS Code recommendations.
    • CI: main-only pipeline verifies rules, OpenAPI sync, typecheck, lint/format, unit/contract tests, build/size, optional e2e; shared composite ./.github/actions/setup.
    • Deploy: staging on main (migrate + force RLS + deploy), production on tags v* with environment gate; job summaries include URLs.
    • Security/quality: CodeQL analysis, dependency review on PRs, weekly Dependabot for npm and GitHub Actions.
  • Migration

    • Open PRs to main; run npm run check locally (full CI runs on main only).
    • Configure secrets for e2e/deploys: DATABASE_URL, MEDIA_SIGNING_SECRET, OCHE_JWT_SECRET, DATABASE_URL_STAGING, DATABASE_URL_PROD, CLOUDFLARE_*.
    • Optional GitHub settings: protect main, require reviewers for production environment, enable Dependabot alerts.

Written for commit e3ad848. Summary will update on new commits.

Review in cubic

- Introduced a Contributor Covenant Code of Conduct to establish community standards for respectful and inclusive participation.
- Added a CONTRIBUTING.md file outlining the development workflow, code standards, and guidelines for submitting pull requests.
- Updated README.md to link to the new CODE_OF_CONDUCT and CONTRIBUTING documents for better visibility.
- Enhanced SECURITY.md to clarify the project's status as a take-home project and provide reporting channels for vulnerabilities.
@Hum2a
Hum2a merged commit 1f4f0e6 into enhancing Jul 3, 2026
1 check passed

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 issues found across 25 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name=".github/workflows/ci.yml">

<violation number="1" location=".github/workflows/ci.yml:102">
P2: Job summary always shows ✅ for every check even on failure — summary should reflect actual step outcomes rather than hardcoding success markers.</violation>
</file>

<file name=".github/ISSUE_TEMPLATE/config.yml">

<violation number="1" location=".github/ISSUE_TEMPLATE/config.yml:7">
P2: The documentation link references `main` as the branch, but this repo uses `master` as its default branch. Users clicking this link will hit a 404. Change `main` to `master` so the docs URL resolves correctly.</violation>
</file>

<file name=".github/workflows/deploy-production.yml">

<violation number="1" location=".github/workflows/deploy-production.yml:6">
P1: Production deploys can now be triggered manually without a `v*` tag, so the workflow no longer enforces the tag-gated release path described in this PR. That creates a bypass where an untagged ref can be promoted to production. Keeping production deploys tag-only (or adding an explicit ref/tag guard for manual runs) would preserve the intended release control.</violation>
</file>

You're on the cubic free plan with 16 free PR reviews remaining this month. Upgrade for unlimited reviews.

Re-trigger cubic

concurrency: { group: production, cancel-in-progress: false }
push:
tags: ['v*']
workflow_dispatch:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1: Production deploys can now be triggered manually without a v* tag, so the workflow no longer enforces the tag-gated release path described in this PR. That creates a bypass where an untagged ref can be promoted to production. Keeping production deploys tag-only (or adding an explicit ref/tag guard for manual runs) would preserve the intended release control.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At .github/workflows/deploy-production.yml, line 6:

<comment>Production deploys can now be triggered manually without a `v*` tag, so the workflow no longer enforces the tag-gated release path described in this PR. That creates a bypass where an untagged ref can be promoted to production. Keeping production deploys tag-only (or adding an explicit ref/tag guard for manual runs) would preserve the intended release control.</comment>

<file context>
@@ -1,21 +1,45 @@
-concurrency: { group: production, cancel-in-progress: false }
+  push:
+    tags: ['v*']
+  workflow_dispatch:
+
+concurrency:
</file context>

Comment thread .github/workflows/ci.yml
echo "| --- | --- |"
echo "| Rules sync | ✅ |"
echo "| OpenAPI export | ✅ |"
echo "| Typecheck / lint / format | ✅ |"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: Job summary always shows ✅ for every check even on failure — summary should reflect actual step outcomes rather than hardcoding success markers.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At .github/workflows/ci.yml, line 102:

<comment>Job summary always shows ✅ for every check even on failure — summary should reflect actual step outcomes rather than hardcoding success markers.</comment>

<file context>
@@ -1,24 +1,106 @@
+            echo "| --- | --- |"
+            echo "| Rules sync | ✅ |"
+            echo "| OpenAPI export | ✅ |"
+            echo "| Typecheck / lint / format | ✅ |"
+            echo "| Unit + contract tests | ✅ |"
+            echo "| Build + bundle budget | ✅ |"
</file context>

url: https://github.com/humza-butt/oche/security/advisories/new
about: Report a vulnerability privately (see SECURITY.md)
- name: Documentation
url: https://github.com/humza-butt/oche/tree/main/docs

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: The documentation link references main as the branch, but this repo uses master as its default branch. Users clicking this link will hit a 404. Change main to master so the docs URL resolves correctly.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At .github/ISSUE_TEMPLATE/config.yml, line 7:

<comment>The documentation link references `main` as the branch, but this repo uses `master` as its default branch. Users clicking this link will hit a 404. Change `main` to `master` so the docs URL resolves correctly.</comment>

<file context>
@@ -0,0 +1,8 @@
+    url: https://github.com/humza-butt/oche/security/advisories/new
+    about: Report a vulnerability privately (see SECURITY.md)
+  - name: Documentation
+    url: https://github.com/humza-butt/oche/tree/main/docs
+    about: Architecture, deployment, and interview prep docs
</file context>
Suggested change
url: https://github.com/humza-butt/oche/tree/main/docs
url: https://github.com/humza-butt/oche/tree/master/docs

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