Update Contributing Documentation#727
Conversation
richarddushime
added
documentation
|
👍 All image files/references (if any) are in webp format, in line with our policy. |
✅ Spell Check PassedNo spelling issues found when checking 2 changed file(s)! 🎉 |
|
✅ Staging Deployment Status This PR has been successfully deployed to staging as part of an aggregated deployment. Deployed at: 2026-05-24 08:57:01 UTC The staging site shows the combined state of all compatible open PRs. |
|
@flavioazevedo @LukasWallrich @rivaquiroga Readme and Contributing files link https://github.com/forrtproject/forrtproject.github.io/tree/contr |
| - Open an [Issue](/issues/new). | ||
| - Provide as much context as you can about the problem you're having. | ||
| - Provide project and platform versions (Hugo, Operating System etc.), depending on what seems relevant. | ||
| If you still need help: |
There was a problem hiding this comment.
I think issues are quite a good way to raise suggestions - on slack they get lost. So I would be more encouraging in this section - search for duplicates, otherwise go for it.
| We will take care of the issue as soon as possible. Right now we run on volunteer time, so please be patient! | ||
| - Open a [new Issue](/issues/new). | ||
| - Provide as much context as you can about the problem. | ||
| - Include relevant versions (Hugo, OS, etc.). |
| When contributing to this project, you confirm that: | ||
|
|
||
| For external contributors, this website operates on the [fork and pull](https://reflectoring.io/github-fork-and-pull/) model, so you will need to fork this repository to your GitHub account of choice and then clone it to your local machine. | ||
| - You authored 100% of the content you are contributing. |
There was a problem hiding this comment.
Not sure what that means. Often people will contribute text that's collaboratively authored - or just a publicly available resources. I would just keep this focused on the license, and then maybe fact-checking.
| For external contributors, this website operates on the [fork and pull](https://reflectoring.io/github-fork-and-pull/) model, so you will need to fork this repository to your GitHub account of choice and then clone it to your local machine. | ||
| - You authored 100% of the content you are contributing. | ||
| - You have the necessary rights to that content. | ||
| - The content may be provided under the project's license. |
There was a problem hiding this comment.
Specify the default - CC BY unless otherwise specified?
There was a problem hiding this comment.
shifting this to Readme
|
|
||
| **Steps** | ||
|
|
||
| 1. Open `.devcontainer/devcontainer.json` in VSCode. |
There was a problem hiding this comment.
Is this still up to date? The tech stack has changed a fair bit and I have never touched the file.
There was a problem hiding this comment.
i doubt if there is even people who use it
so to keep the docs simplified i will remove it and leave the standard informations for VScode
| - Deployment statistics | ||
|
|
||
| --- | ||
| Thank you for contributing to FORRT and helping build a more open, reproducible, and inclusive research culture. |
There was a problem hiding this comment.
Do we need to say something about AI here? I would say contributions co-authored with agents are welcome, but only if you have reviewed both code and content fully. Also, if a contribution consists of running a single prompt, consider posting the prompt/idea as an issue instead - it will then often be faster for us to run the prompt with the full understanding of the coding conventions than to review and integrate purely vibe-coded contributions.
There was a problem hiding this comment.
I think no need to add it, we still dont have a large number of contributors
|
|
||
| ### The solution | ||
| ## About FORRT | ||
|
|
There was a problem hiding this comment.
I would suggest we just link to the website. Keeping this updated is a hard job - and the current writing is really out of date, shaping students education is a very small part of what Forrt does
| - **Slack**: [Join FORRT's Slack workspace](https://join.slack.com/t/forrt/shared_invite/zt-alobr3z7-NOR0mTBfD1vKXn9qlOKqaQ) and introduce yourself with a brief message: | ||
|
|
||
| This is the website for the **Framework for Open and Reproducible Research Training (FORRT)**, built with [hugo](https://gohugo.io/), and deployed with [Github Actions](https://docs.github.com/en/actions). You can find the website at [forrt.org](https://forrt.org/). See CONTRIBUTING.md for more information on how to contribute. | ||
| > "Hi everyone, I am a ___ (e.g., doctoral researcher, postdoctoral fellow, assistant professor) in ___ (field of study) at ___ (institution), and I would be glad to contribute to ___." |
There was a problem hiding this comment.
Do we need this template? Feels slightly odd to tell people how to write such a basic introduction in a place where very few people find out about us.
|
|
||
| A community member will direct you to relevant documents and open tasks. | ||
|
|
||
| - **Manuscript**: Contribute to the FORRT manuscript via [this collaborative Google Doc](https://tinyurl.com/FORRTworkingDOC). |
There was a problem hiding this comment.
Remove - not current
| A community member will direct you to relevant documents and open tasks. | ||
|
|
||
| - **Manuscript**: Contribute to the FORRT manuscript via [this collaborative Google Doc](https://tinyurl.com/FORRTworkingDOC). | ||
| - **Other initiatives**: Explore the full range of FORRT tools and projects at [github.com/forrtproject](https://github.com/forrtproject). |
|
|
||
| --- | ||
|
|
||
| ## License |
There was a problem hiding this comment.
@LukasWallrich i am updating this licence to cc by as a default
There was a problem hiding this comment.
then I will update the @Licence.md texts
2 participants
Description
Fixes # (issue)
Type of Change
Testing
Checklist
Notes