Skip to content

[limen GH-organvm-dot-github-logos-18] Simplify CONTRIBUTING.md to standard PR workflows #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
4444J99 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[limen GH-organvm-dot-github-logos-18] Simplify CONTRIBUTING.md to standard PR workflows #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 24 additions & 47 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,59 +1,36 @@
# Contributing

Thanks for your interest in contributing! This organization publishes essays,
process documentation, and methodology writing, along with the automation that
supports them. Contributions of all sizes are welcome — typo fixes, docs, bug
fixes, and new ideas.
Thanks for your interest in contributing. This repository contains organization
profile and community health files, including shared documentation, templates,
and policy files.
Comment on lines +3 to +5

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 1, 2026

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 Badge Keep the default CONTRIBUTING text repository-neutral

Because this .github repo publishes community-health defaults to sibling repositories that do not define their own CONTRIBUTING.md (the activation audit documents that fallback), this new repo-specific description will also appear in those repos and incorrectly tells contributors to projects like public-process or essay-pipeline that the repository contains only org profile/community-health files. Please make this introduction organization-wide or repository-neutral so the default guidance remains accurate when GitHub reuses it across the org.

Useful? React with 👍 / 👎.


By participating, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).

## Ways to contribute

- **Report a bug or suggest an idea** — open an [issue](../../issues). For
anything large (a new essay topic, a change to the publishing workflow, an
editorial policy update), open an issue to discuss it before writing code.
- **Pick up existing work** — issues labeled `good first issue` are a great
starting point.
- **Open a pull request** — see the workflow below.
- **Report a security vulnerability** — please follow [SECURITY.md](SECURITY.md)
instead of opening a public issue.
- Report a bug or suggest an improvement by opening an [issue](../../issues).
- Fix a typo, update documentation, or improve a template with a pull request.
- For larger changes, open an issue first so maintainers can discuss the
direction before you spend time on implementation.
- To report a security vulnerability, follow [SECURITY.md](SECURITY.md) instead
of opening a public issue.

## Pull request workflow

1. **Fork** the repository and create a branch from `main`.
2. **Make your change.** Match the style of the surrounding code or prose, and
keep the change focused — smaller PRs are easier to review and merge.
3. **Run the repo's checks** (tests, lint, build) if it has them. Each repo's
`README` lists its setup and validation commands.
4. **Open a pull request** with a clear description of what changed and why.
Link any related issue.

A maintainer will review and may suggest changes before merging. We aim to give
an initial response within a few business days; please be patient if it takes a
little longer.

## Style guidelines

These are conventions, not gates — follow them where they apply, and ask if
you're unsure.

- **Commits** — write clear messages in the imperative mood ("Fix typo in
intro"), with a title under ~72 characters.
- **TypeScript** — strict mode, named exports, `async/await`.
- **Python** — PEP 8, type hints, f-strings.
- **READMEs** — follow the [README standards](README_STANDARDS.md).
- **Essays** — include the YAML frontmatter described in the publishing guide
(title, author, date, tags, category, excerpt, and the other fields listed
there).
- **Tests** — if you change code that has tests, please keep them passing and
add coverage for new behavior.

## Getting help

- Open an [issue](../../issues) with any question.
- Check the relevant repo's `README` — it's the source of truth for that repo's
setup and workflow.

---
1. Fork the repository and create a branch from `main`.
2. Make a focused change. Keep pull requests small when possible.
3. Run any relevant checks listed in the `README`. If there are no checks, or
you could not run them, note that in the pull request.
4. Open a pull request with a clear description of what changed and why. Link
any related issue.
5. Respond to review comments if maintainers request changes.

Maintainers will review pull requests as time allows. Once a pull request is
approved and any required checks pass, a maintainer will merge it.
Comment on lines 18 to +29

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 1, 2026

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 Badge Restore the secure-coding guidance target

SECURITY.md still directs contributors to “follow secure coding practices per CONTRIBUTING.md”, but this rewrite removes the only standards/style section from CONTRIBUTING.md, and a repo-wide search shows no remaining secure-coding guidance there. In security-sensitive changes, that cross-reference now lands on a generic PR workflow instead of the practices it promises, so either keep a minimal secure-coding/standards section here or update the security policy to point at the actual source.

Useful? React with 👍 / 👎.


## Questions

If you are not sure where to start, open an [issue](../../issues) with your
question or ask on the pull request.

*Part of the [organvm system](https://github.com/meta-organvm).*
22 changes: 9 additions & 13 deletions QUICK_START.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,9 @@ README — it is authoritative if it differs from the above.
### Code / automation repos

`essay-pipeline`, `analytics-engine`, and `reading-observatory` are code
repositories. Per the [contribution standards](CONTRIBUTING.md) they use:

- **TypeScript** — strict mode, named exports, `async/await`
- **Python** — PEP 8, type hints, f-strings

After installing dependencies, run the repo's test command (listed in its
README) to confirm a working local setup before making changes.
repositories. Use each repo's `README` as the source of truth for setup, style,
and checks. After installing dependencies, run the test or lint command listed
there before making changes.

---

Expand All @@ -88,20 +84,20 @@ README) to confirm a working local setup before making changes.
Once you can run things locally:

1. Pick an issue labeled **`good first issue`**.
2. Confirm scope, validation commands, and acceptance criteria before coding.
3. Fork → branch (`feature/your-feature` or `fix/your-fix`) → keep changes focused.
2. Fork the repo and create a branch from `main`.
3. Make a focused change.
4. Run the repo's local validation commands.
5. Open a PR with a clear description.
5. Open a pull request with a clear description.

Full details — accepted change types, review SLAs, development standards — are in
**[CONTRIBUTING.md](CONTRIBUTING.md)**.
See **[CONTRIBUTING.md](CONTRIBUTING.md)** for the standard pull request
workflow.

---

## Where to go next

- **[Organization profile](profile/README.md)** — what ORGAN-V is and how it fits the eight-organ system
- **[CONTRIBUTING.md](CONTRIBUTING.md)** — full contribution workflow and standards
- **[CONTRIBUTING.md](CONTRIBUTING.md)** — contribution workflow
- **[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)** — community expectations
- **[SECURITY.md](SECURITY.md)** — reporting vulnerabilities
- **[README standards](README_STANDARDS.md)** — README structure each repo follows
Expand Down
2 changes: 1 addition & 1 deletion docs/activation-audit-2026.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ real?**
| --- | --- | --- |
| `profile/README.md` | LIVE | Org-profile surface; substantive, renders publicly |
| `README.md` | LIVE | Repo landing; links the governance assets |
| `CONTRIBUTING.md` | LIVE | Standard fork → branch → PR workflow, 59 lines |
| `CONTRIBUTING.md` | LIVE | Standard fork → branch → PR workflow |
| `CODE_OF_CONDUCT.md` | LIVE | 78 lines |
| `SECURITY.md` | LIVE | Advisory + email path, response timeline |
| `QUICK_START.md` | LIVE | Newcomer entry point, linked from both READMEs |
Expand Down