From ec5491e8cf78c8ceb696dac278160b187f645b69 Mon Sep 17 00:00:00 2001 From: Adam Blanchard Date: Mon, 27 Oct 2025 15:38:00 +0100 Subject: [PATCH 1/6] update contributor guide --- contributing/README.md | 47 +++++++++++++++++++++++------------------- 1 file changed, 26 insertions(+), 21 deletions(-) diff --git a/contributing/README.md b/contributing/README.md index 3f8dbdf1..b928126d 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -2,11 +2,35 @@ Everyone is welcome to fork/clone the repo and contribute to improving the program. -If you would like to take a more active role in contributing as a volunteer of HYF Denmark, join #curriculum-crew on Slack to get involved. -Write in there to introduce yourself, and a staff member will onboard you and set you up with permissions. +If you would like to take a more active role in contributing to this program as a volunteer of HYF Denmark, drop an introduction in #mentorroom and a staff member will help onboard you. If you're not already a mentor, sign up your interest at [hackyourfuture.dk/volunteer](https://hackyourfuture.dk/volunteer). ## How to contribute +### 1. Sharing feedback + +After taking in a Sunday session, we strongly encourage mentors to evaluate how it went using the feedback form bookmarked in #mentorroom on Slack. + +### 2. Suggestions and improvements + +If you come across issues or ideas for improvements along the way, please create a pull request (or a [GitHub issue](https://github.com/HackYourFuture-CPH/program/issues), if you're not sure how to implement it) and share in #mentorroom for visibility and feedback. + +You are welcome to browse the list of [open issues](https://github.com/HackYourFuture-CPH/program/issues) as well, and pick any up that you think you can contribute to. All of the help is appreciated! + +### 3. Questions, bigger ideas and more + +If you're unsure about something in the program, have an idea for a bigger improvement, new module or something else, start a conversation in #mentorroom as a first step for getting answers and feedback from other mentors and staff members. + +## How permissions work + +Permissions are managed through GitHub teams, their roles on this repo, and branch rules. + +- _HYF Staff_ members have the admin role (to do things like changing repo settings, inviting new contributors). +- Members of the _Curriculum Crew_ team on GitHub have the write role (to do things like cloning, pushing branches, approving PRs - any volunteer is welcome here!). +- One approval by anyone in _Curriculum Crew_ or _HYF Staff_ are required on a PR before merging is allowed. +- Merging to Main can be performed by any _HYF Staff_ member. + +## Setting up and using your local environment + This project is a collection of structured README files. To maintain consistency and quality, we use a linter and suggest some recommended editor extensions. ### 1. Install dependencies @@ -49,22 +73,3 @@ To automatically fix some issues: > [!TIP] > On **Windows** you cannot run bash scripts natively. In this case, open the folder in your Git Bash shell and run the commands from in there. - -### Existing issues - -Very briefly: check the project board "Todo" column, choose one ideally near the top, assign it, clone the repo, do it, make a PR, get feedback, profit. - -### New ideas - -Very briefly: Create an issue on this repo, get some feedback, and we'll prioritize them together at the next meeting. - -Note: You are always welcome to open issues/create PRs for new ideas, whenever you like. It's an open source project. If we are currently working together towards a project goal, then it would be most helpful to prioritize tasks for that first, though. - -## How permissions work - -Permissions are managed through GitHub teams, their roles on this repo, and branch rules. - -- _HYF Staff_ members have the admin role (to do things like changing repo settings, inviting new contributors). -- Members of the _Curriculum Crew_ team on GitHub have the write role (to do things like cloning, pushing branches, approving PRs - any volunteer is welcome here!). -- Two approvals by anyone in _Curriculum Crew_ or _HYF Staff_ are required on a PR before merging is allowed. -- Merging to Main can be performed by any _HYF Staff_ member. From acfb4c78513055b3a7abb7d26f67ed5e81b6bce1 Mon Sep 17 00:00:00 2001 From: Adam Blanchard Date: Mon, 27 Oct 2025 16:00:53 +0100 Subject: [PATCH 2/6] Apply suggestion from @adamblanchard --- contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/README.md b/contributing/README.md index b928126d..3893cfc3 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -8,7 +8,7 @@ If you would like to take a more active role in contributing to this program as ### 1. Sharing feedback -After taking in a Sunday session, we strongly encourage mentors to evaluate how it went using the feedback form bookmarked in #mentorroom on Slack. +After taking part in a Sunday session, we strongly encourage mentors to evaluate how it went using the feedback form bookmarked in #mentorroom on Slack. ### 2. Suggestions and improvements From 92511432a22f6401eeadea9f6d8358a603ecef74 Mon Sep 17 00:00:00 2001 From: Adam Blanchard Date: Tue, 28 Oct 2025 09:45:21 +0100 Subject: [PATCH 3/6] Update contributing/README.md Co-authored-by: rve.rc --- contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/README.md b/contributing/README.md index 3893cfc3..d4f4bbf0 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -14,7 +14,7 @@ After taking part in a Sunday session, we strongly encourage mentors to evaluate If you come across issues or ideas for improvements along the way, please create a pull request (or a [GitHub issue](https://github.com/HackYourFuture-CPH/program/issues), if you're not sure how to implement it) and share in #mentorroom for visibility and feedback. -You are welcome to browse the list of [open issues](https://github.com/HackYourFuture-CPH/program/issues) as well, and pick any up that you think you can contribute to. All of the help is appreciated! +You are welcome to browse the list of [open issues](https://github.com/HackYourFuture-CPH/program/issues) as well, and pick any up that you think you can contribute to. All help is appreciated! ### 3. Questions, bigger ideas and more From a8ee695977495386f0f1f0a15a25a92a3766ec6f Mon Sep 17 00:00:00 2001 From: Adam Blanchard Date: Tue, 28 Oct 2025 09:45:45 +0100 Subject: [PATCH 4/6] Update contributing/README.md Co-authored-by: rve.rc --- contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/README.md b/contributing/README.md index d4f4bbf0..3473d945 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -18,7 +18,7 @@ You are welcome to browse the list of [open issues](https://github.com/HackYourF ### 3. Questions, bigger ideas and more -If you're unsure about something in the program, have an idea for a bigger improvement, new module or something else, start a conversation in #mentorroom as a first step for getting answers and feedback from other mentors and staff members. +If you're unsure about something in the program, or you have an idea for a bigger improvement, a new module, or something else, then please start a conversation in #mentorroom as a first step for getting answers and feedback from other mentors and staff members. ## How permissions work From f775d5695bd8419875c6e5b19c3e0a4fe6feb12b Mon Sep 17 00:00:00 2001 From: Adam Blanchard Date: Tue, 28 Oct 2025 09:45:57 +0100 Subject: [PATCH 5/6] Update contributing/README.md Co-authored-by: rve.rc --- contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/README.md b/contributing/README.md index 3473d945..501efb8f 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -27,7 +27,7 @@ Permissions are managed through GitHub teams, their roles on this repo, and bran - _HYF Staff_ members have the admin role (to do things like changing repo settings, inviting new contributors). - Members of the _Curriculum Crew_ team on GitHub have the write role (to do things like cloning, pushing branches, approving PRs - any volunteer is welcome here!). - One approval by anyone in _Curriculum Crew_ or _HYF Staff_ are required on a PR before merging is allowed. -- Merging to Main can be performed by any _HYF Staff_ member. +- Merging to `main` can be performed by any _HYF Staff_ member. ## Setting up and using your local environment From e6c877e72546bbff80ac7d7fc0c46ea0d841b3f4 Mon Sep 17 00:00:00 2001 From: Adam Blanchard Date: Tue, 28 Oct 2025 09:46:13 +0100 Subject: [PATCH 6/6] Update contributing/README.md Co-authored-by: rve.rc --- contributing/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/README.md b/contributing/README.md index 501efb8f..44cf0148 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -26,7 +26,7 @@ Permissions are managed through GitHub teams, their roles on this repo, and bran - _HYF Staff_ members have the admin role (to do things like changing repo settings, inviting new contributors). - Members of the _Curriculum Crew_ team on GitHub have the write role (to do things like cloning, pushing branches, approving PRs - any volunteer is welcome here!). -- One approval by anyone in _Curriculum Crew_ or _HYF Staff_ are required on a PR before merging is allowed. +- One approval by anyone in _Curriculum Crew_ or _HYF Staff_ is required on a PR before merging is allowed. - Merging to `main` can be performed by any _HYF Staff_ member. ## Setting up and using your local environment