Skip to content

feat (guidelines): add OCaml guidelines - #220

Open
Owen-sz wants to merge 3 commits into
mainfrom
owen/peak
Open

Owen-sz wants to merge 3 commits into
mainfrom
owen/peak

Conversation

@Owen-sz

@Owen-sz Owen-sz commented Oct 22, 2026

Copy link
Copy Markdown
Member

No description provided.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
terra-docs d47ed4f Commit Preview URL

Branch Preview URL
Oct 23 2026, 01:54 AM

Comment thread src/content/docs/contributing/guidelines.mdx Outdated
@Owen-sz
Owen-sz requested a review from GildedRoach October 23, 2026 01:45
@github-actions

Copy link
Copy Markdown

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the tracking.ignoredKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
src/content/docs/contributing/guidelines.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

- Initial commit
```

ocaml-* OCaml packages SHOULD be placed in anda/langs/ocaml, with the folder and spec named with ocaml-*.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

TBH I don't think the folder should start with ocaml- nor would the spec need to, it's already in langs/ocaml?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It's how Fedora does it, and currently how all the Haskell/OCaml packages do it in Terra. Example - https://src.fedoraproject.org/rpms/ocaml-ppx-bin-prot/blob/rawhide/f/ocaml-ppx-bin-prot.spec

We could mass change this in Terra but beyond the scope of this PR imo

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Mass changing it in Terra is sure, but enforcing this as our rules feels strange.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It's for uniformity, it's just a SHOULD not a MUST. Haskell has the same thing

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Well per the RFC RFC SHOULD means it's heavily discouraged without a good reason not to. IDK I guess it's fine, just seems stupid and makes unnecessarily long folder/file names I have to deal with when rebuilding stuff LMAO.

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.

2 participants