Skip to content

Clarify website onboarding and fork staging previews - #908

Open
LukasWallrich wants to merge 4 commits into
mainfrom
docs/contributor-guide
Open

LukasWallrich wants to merge 4 commits into
mainfrom
docs/contributor-guide

Conversation

@LukasWallrich

@LukasWallrich LukasWallrich commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Make the website contribution guide usable for first-time contributors: add browser-only content edits, correct fork/sync/push commands, pin Hugo Extended 0.158.0 to the workflows, and explain generated content and fork staging previews. Clarify the existing repository and contribution licences and link FORRT's Code of Conduct.

Validation: checked commands and staging behaviour against current deploy workflows; checked local link targets and the canonical conduct URL; git diff --check passed. Opus 5.5 reviewed the guide, its findings were applied, and a final review approved it. Documentation only; no site build or deployment was run.


Summary by cubic

Opens the website contribution guide to browser-only edits and aligns the fork workflow with how staging actually deploys.

  • Corrects fork, sync, and push commands for both git and RStudio setups to use the contributor's own fork plus an upstream remote.
  • Pins Hugo Extended to 0.158.0 to match production and staging.
  • Explains which content is generated during deployment and must be changed via source forms, naming files like data/publications.yaml and the generated static/data/fred_citation.txt.
  • Details the maintainer-run single_pr preview for external forks and the monthly report's skipped-PR list.
  • Separates the repository licence (CC BY-NC-SA 4.0) from the contribution policy (CC BY 4.0) and links the Code of Conduct.

Written for commit 5c36406. Summary will update on new commits.

View guided diff Turn on auto-fix

@LukasWallrich
LukasWallrich requested a review from a team as a code owner October 8, 2026 12:13
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

👍 All image files/references (if any) are in webp format, in line with our policy.

@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

✅ Spell Check Passed

No spelling issues found when checking 1 changed file(s)! 🎉

@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.

1 issue found across 1 file

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="CONTRIBUTING.md">

<violation number="1" location="CONTRIBUTING.md:196">
P3: Monthly reports omit skipped PR numbers when every attempted PR conflicts because the workflow only emits that section when at least one PR was included. Fix the summary condition or qualify this documentation.</violation>
</file>

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
- Successfully merged PRs
- Skipped PRs (with conflict details)
- Deployment statistics
- Skipped PR numbers (labelled as merge conflicts)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P3: Monthly reports omit skipped PR numbers when every attempted PR conflicts because the workflow only emits that section when at least one PR was included. Fix the summary condition or qualify this documentation.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At CONTRIBUTING.md, line 196:

<comment>Monthly reports omit skipped PR numbers when every attempted PR conflicts because the workflow only emits that section when at least one PR was included. Fix the summary condition or qualify this documentation.</comment>

<file context>
@@ -162,32 +175,26 @@ The FORRT website uses a dual deployment strategy to ensure quality and enable c
 - Successfully merged PRs
-- Skipped PRs (with conflict details)
-- Deployment statistics
+- Skipped PR numbers (labelled as merge conflicts)
+- Aggregate branch and deployment time
 
</file context>

@LukasWallrich

LukasWallrich commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor Author

✅ Staging Deployment Status

This PR has been successfully deployed to staging as part of an aggregated deployment.

Deployed at: 2026-10-14 15:44:11 UTC
Staging URL: https://staging.forrt.org

The staging site shows the combined state of all compatible open PRs.

@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.

All reported issues were addressed across 1 file (changes from recent commits).

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md

- [Git](https://git-scm.com/downloads)
- [Hugo](https://gohugo.io/getting-started/installing/)
- [Hugo Extended](https://gohugo.io/getting-started/installing/) **0.158.0**, matching the production and staging workflows

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the hugo version is optionnal , for development any latest version can work

Comment thread CONTRIBUTING.md

- [Git](https://git-scm.com/downloads)
- [Hugo](https://gohugo.io/getting-started/installing/)
- [Hugo Extended](https://gohugo.io/getting-started/installing/) **0.158.0**, matching the production and staging workflows

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

same here the version is optional

Comment thread CONTRIBUTING.md
### How Staging Works

When a PR is opened, synchronised, or reopened, the staging workflow:
Automatic staging collects open, non-draft PRs targeting `main` and merges them in sequence onto a temporary branch. Conflicting PRs are skipped and logged. Inclusion in staging does not mean a PR has passed review or been approved for merging. The workflow posts staging results to PRs and retains two recent staging branches.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

non-draft PRs are not auto deployed to staging

@richarddushime richarddushime left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Made fews comments

A suggestion would be adding a line about the Spell Checker(spelling issues found ) on each PR

This branch has not been deployed

No deployments
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