Skip to content

Update Contributing Documentation#727

Merged
LukasWallrich merged 10 commits into
mainfrom
contr
Jun 10, 2026
Merged

Update Contributing Documentation#727
LukasWallrich merged 10 commits into
mainfrom
contr

Conversation

@richarddushime

@richarddushime richarddushime commented Mar 31, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

Fixes # (issue)

Type of Change

  • Content/documentation update

Testing

Checklist

  • Self-reviewed my changes
  • Verified links and formatting are correct
  • No new warnings or errors

Notes

@richarddushime richarddushime added documentation Improvements or additions to documentation In Progress labels Mar 31, 2026
@github-actions

github-actions Bot commented Mar 31, 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 Mar 31, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

✅ Spell Check Passed

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

@richarddushime richarddushime marked this pull request as ready for review May 21, 2026 21:36
@richarddushime richarddushime requested a review from a team as a code owner May 21, 2026 21:36
@LukasWallrich

LukasWallrich commented May 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

✅ Staging Deployment Status

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

Deployed at: 2026-06-10 17:06:38 UTC
Staging URL: https://staging.forrt.org

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

@richarddushime

richarddushime commented May 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@flavioazevedo @LukasWallrich @rivaquiroga
the contents needs your attention

Readme and Contributing files

link https://github.com/forrtproject/forrtproject.github.io/tree/contr

LukasWallrich
LukasWallrich reviewed May 23, 2026
View reviewed changes
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
richarddushime
richarddushime commented May 24, 2026
View reviewed changes
Comment thread README.md
@LukasWallrich LukasWallrich mentioned this pull request Jun 1, 2026
Open
LukasWallrich and others added 3 commits June 10, 2026 18:02
@LukasWallrich @claude
Address review: restore CC BY-NC-SA site license, rework issues/AI/li…
651c2a5 
…censing guidance

- README: restore site license to CC BY-NC-SA 4.0 (PR had regressed it to CC BY 4.0)
  to match LICENSE.md; link to full text
- README: fix two typos in the quick-start section
- CONTRIBUTING: rewrite the questions section to actively encourage issues/suggestions
- CONTRIBUTING: drop the "authored 100% of the content" requirement; add fact-checking
  guidance and clarify contributions default to CC BY 4.0 unless stated otherwise
- CONTRIBUTING: add encouraging guidance on contributing with AI tools

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@LukasWallrich
Update contribution guidelines for issue submissions
cb94603 
Clarify the purpose of issues for suggestions and resources.
@LukasWallrich
Update CONTRIBUTING.md
2fcdd9d
@LukasWallrich

LukasWallrich commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Pushed a follow-up commit addressing the remaining review points:

  • License: restored the site license to CC BY-NC-SA 4.0 in the README (the PR had regressed it to CC BY 4.0) to match LICENSE.md.
  • Issues section: rewritten to actively encourage questions, ideas and suggestions as issues.
  • Contribution licensing: dropped the "authored 100% of the content" requirement; added fact-checking guidance and clarified that contributions default to CC BY 4.0 unless stated otherwise.
  • AI tools: added encouraging guidance — agent-assisted contributions welcome if fully reviewed; single-prompt ideas are better posted as issues.
  • README typos fixed.

Two minor things left as-is (Richard's call): the RStudio section was kept (improved with usethis + a caveat) rather than removed, and the PR deletes .devcontainer/dev/devcontainer.json. Resolving threads and merging.

LukasWallrich
LukasWallrich approved these changes Jun 10, 2026
View reviewed changes

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

Follow-up changes address the review comments. Approving.

@LukasWallrich LukasWallrich merged commit 9f3b274 into main Jun 10, 2026
2 checks passed
@LukasWallrich LukasWallrich deleted the contr branch June 10, 2026 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@LukasWallrich LukasWallrich LukasWallrich approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@richarddushime @LukasWallrich