Skip to content

Commit 98760cc

Browse files
Merge pull request #214 from HackYourFuture-CPH/update-contributing-guide
Update contributor guide
2 parents e0b2456 + e6c877e commit 98760cc

File tree

1 file changed

+26
-21
lines changed

1 file changed

+26
-21
lines changed

contributing/README.md

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,35 @@
22

33
Everyone is welcome to fork/clone the repo and contribute to improving the program.
44

5-
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.
6-
Write in there to introduce yourself, and a staff member will onboard you and set you up with permissions.
5+
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).
76

87
## How to contribute
98

9+
### 1. Sharing feedback
10+
11+
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.
12+
13+
### 2. Suggestions and improvements
14+
15+
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.
16+
17+
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!
18+
19+
### 3. Questions, bigger ideas and more
20+
21+
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.
22+
23+
## How permissions work
24+
25+
Permissions are managed through GitHub teams, their roles on this repo, and branch rules.
26+
27+
- _HYF Staff_ members have the admin role (to do things like changing repo settings, inviting new contributors).
28+
- 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!).
29+
- One approval by anyone in _Curriculum Crew_ or _HYF Staff_ is required on a PR before merging is allowed.
30+
- Merging to `main` can be performed by any _HYF Staff_ member.
31+
32+
## Setting up and using your local environment
33+
1034
This project is a collection of structured README files. To maintain consistency and quality, we use a linter and suggest some recommended editor extensions.
1135

1236
### 1. Install dependencies
@@ -49,22 +73,3 @@ To automatically fix some issues:
4973

5074
> [!TIP]
5175
> 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.
52-
53-
### Existing issues
54-
55-
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.
56-
57-
### New ideas
58-
59-
Very briefly: Create an issue on this repo, get some feedback, and we'll prioritize them together at the next meeting.
60-
61-
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.
62-
63-
## How permissions work
64-
65-
Permissions are managed through GitHub teams, their roles on this repo, and branch rules.
66-
67-
- _HYF Staff_ members have the admin role (to do things like changing repo settings, inviting new contributors).
68-
- 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!).
69-
- Two approvals by anyone in _Curriculum Crew_ or _HYF Staff_ are required on a PR before merging is allowed.
70-
- Merging to Main can be performed by any _HYF Staff_ member.

0 commit comments

Comments
 (0)