Skip to content

Commit c17f148

Browse files
authored
Merge pull request #352 from TraderAlice/UI-issue
docs: contributor recognition (CONTRIBUTORS.md + README wall + CLAUDE.md convention)
2 parents 2b8ecba + 56a973a commit c17f148

3 files changed

Lines changed: 88 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -537,6 +537,33 @@ flow.
537537
specific PR ("evaluate #N anyway, I know the author"), not a general
538538
"go ahead" earlier in the session.
539539

540+
### Recognizing contributors — credit, don't merge
541+
542+
We refuse external code, but the project stays open and community ideas /
543+
reports / designs genuinely shape it. Recognizing those people is deliberate
544+
operations (part of the growth flywheel), not a courtesy. It lives in two
545+
**hand-maintained** files — no script; the volume doesn't justify one:
546+
547+
- **`CONTRIBUTORS.md`** — the credits ledger + a short "how recognition works"
548+
guide. Each entry links to the actual change the person influenced, so it's a
549+
record, not just a name on a wall.
550+
- **`README.md``## Contributors`** — the avatar wall + a pointer to the ledger.
551+
- Not to be confused with **`CONTRIBUTING.md`** (the rules doc). Mnemonic:
552+
`-ING` = how to contribute; `-ORS` = who contributed.
553+
554+
**To credit someone** (maintainer's call; standouts ⭐ go on top): hand-edit
555+
`CONTRIBUTORS.md` using the row template in its HTML comment — the avatar is free
556+
from `https://github.com/<handle>.png` (no token), link the "Shaped" cell to the
557+
PR / commit / issue they moved, pick a credit emoji from the list at the top of
558+
the file. Optionally add them to the README wall too.
559+
560+
**IP-clean rule — NEVER `Co-Authored-By:` for a human.** That trailer asserts
561+
co-authorship (a copyright claim), which breaks the single-owner stance that is
562+
the whole reason we don't merge external code. Credit humans via the
563+
`CONTRIBUTORS` page, and — only if you want a git-level record — a non-authorship
564+
trailer (`Suggested-by:` / `Reported-by:` / `Reviewed-by: @handle`). Claude's
565+
`Co-Authored-By:` stays as-is (an AI asserts no copyright).
566+
540567
### Two collaboration modes — pick the right one first
541568

542569
The whole workflow forks on one question:

CONTRIBUTORS.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributors
2+
3+
OpenAlice is built and maintained in-house, and we **don't merge external pull
4+
requests** — anything that touches trading or keys has to be ours (see
5+
[CONTRIBUTING.md](./CONTRIBUTING.md) for why). But the project stays open, and
6+
the community's **ideas, bug reports, designs, and reviews genuinely shape it**.
7+
This page is the record of those people, and of what each one helped move.
8+
9+
## How recognition works
10+
11+
- We don't merge your code, but if your **idea / report / design / review**
12+
shaped a change, you get credited here, with a link to the actual change you
13+
influenced. It's a real record, not just a name on a wall.
14+
- **Credit types:**
15+
🤔 ideas · 🎨 design · 🐛 bug report · 👀 review · 💬 question answered ·
16+
📖 docs · 🛡️ security · 🌍 translation · 💻 code _(rare — reimplemented with
17+
your consent)_
18+
- **How to earn one:** open an
19+
[issue](https://github.com/TraderAlice/OpenAlice/issues) with an idea, a
20+
report, or a design. If it lands in the project, we add you. Think we missed
21+
crediting you? Say so in an issue or on Discord — we'll fix it.
22+
- **Standouts (⭐):** a few people go notably above and beyond — high-signal,
23+
consistent, often right. They sit at the top.
24+
25+
## The roll
26+
27+
<!--
28+
Maintainer note — adding someone:
29+
• Put standouts (⭐) first; everyone else below, newest-ish at the bottom.
30+
• The avatar comes free from https://github.com/<handle>.png — no token.
31+
• Link each "Shaped" item to the PR / commit / issue it influenced.
32+
• Pick credit emoji from the list above; honesty over generosity isn't the
33+
goal here — credit them for what they actually moved.
34+
35+
Row template (copy this):
36+
37+
| ⭐ | <a href="https://github.com/HANDLE"><img src="https://github.com/HANDLE.png" width="40" height="40" alt="@HANDLE" /></a><br>[@HANDLE](https://github.com/HANDLE) | 🤔 🎨 | [what they shaped](LINK) |
38+
-->
39+
40+
| | Contributor | Credits | Shaped |
41+
|:--:|---|:--:|---|
42+
| | _Be the first — open an issue with an idea or report._ [Issues →](https://github.com/TraderAlice/OpenAlice/issues) | | |
43+
44+
---
45+
46+
_This is the credits list (`CONTRIBUTORS`), not the contribution guide. For the
47+
rules — what we accept and why — see [`CONTRIBUTING.md`](./CONTRIBUTING.md)._

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -512,6 +512,20 @@ Stuck? Here's the recommended path, roughly in order:
512512

513513
[![Star History Chart](https://api.star-history.com/svg?repos=TraderAlice/OpenAlice&type=Date)](https://star-history.com/#TraderAlice/OpenAlice&Date)
514514

515+
## Contributors
516+
517+
We build OpenAlice in-house and [don't merge external PRs](./CONTRIBUTING.md)
518+
but the community's ideas, reports, and designs shape it, and we credit every
519+
one. The people who've left a mark:
520+
521+
<!-- Standouts (⭐) first. Avatars come free from https://github.com/<handle>.png :
522+
<a href="https://github.com/HANDLE"><img src="https://github.com/HANDLE.png" width="56" height="56" alt="@HANDLE" /></a> -->
523+
<p>
524+
<em>No one on the wall yet — <a href="https://github.com/TraderAlice/OpenAlice/issues">be the first</a>.</em>
525+
</p>
526+
527+
**See the full list and what each person shaped**[CONTRIBUTORS.md](./CONTRIBUTORS.md)
528+
515529
## License
516530

517531
[AGPL-3.0](LICENSE)

0 commit comments

Comments
 (0)